Bridge MDC API

Device

getDevice

Retrieve an individual device.


/devices/{deviceId}

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/devices/{deviceId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceApi;

import java.io.File;
import java.util.*;

public class DeviceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DeviceApi apiInstance = new DeviceApi();
        String deviceId = deviceId_example; // String | UUID of a device
        try {
            device result = apiInstance.getDevice(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceApi#getDevice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeviceApi;

public class DeviceApiExample {

    public static void main(String[] args) {
        DeviceApi apiInstance = new DeviceApi();
        String deviceId = deviceId_example; // String | UUID of a device
        try {
            device result = apiInstance.getDevice(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceApi#getDevice");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *deviceId = deviceId_example; // UUID of a device

DeviceApi *apiInstance = [[DeviceApi alloc] init];

// Retrieve an individual device.
[apiInstance getDeviceWith:deviceId
              completionHandler: ^(device output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.DeviceApi()

var deviceId = deviceId_example; // {String} UUID of a device


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDevice(deviceId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDeviceExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeviceApi();
            var deviceId = deviceId_example;  // String | UUID of a device

            try
            {
                // Retrieve an individual device.
                device result = apiInstance.getDevice(deviceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceApi.getDevice: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DeviceApi();
$deviceId = deviceId_example; // String | UUID of a device

try {
    $result = $api_instance->getDevice($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeviceApi->getDevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeviceApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DeviceApi->new();
my $deviceId = deviceId_example; # String | UUID of a device

eval { 
    my $result = $api_instance->getDevice(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeviceApi->getDevice: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DeviceApi()
deviceId = deviceId_example # String | UUID of a device

try: 
    # Retrieve an individual device.
    api_response = api_instance.get_device(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->getDevice: %s\n" % e)

Parameters

Path parameters
Name Description
deviceId*
String
UUID of a device
Required

Responses

Status: 200 - Device found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 404 - Unable to find the device for the given deviceId parameter.

Status: 500 - Internal server error

Status: 502 - Received subservice error.


getDevices

Retrieve all devices.


/devices

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/devices?deviceName=&limit=&offset=&physicalQuantity="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceApi;

import java.io.File;
import java.util.*;

public class DeviceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DeviceApi apiInstance = new DeviceApi();
        String deviceName = deviceName_example; // String | The name of the device (e.g. S7 1212C DC), which could also be an abstract device (e.g. Welding 247)
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        String physicalQuantity = physicalQuantity_example; // String | The physical quantity that is measured at a device
        try {
            deviceCollection result = apiInstance.getDevices(deviceName, limit, offset, physicalQuantity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceApi#getDevices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeviceApi;

public class DeviceApiExample {

    public static void main(String[] args) {
        DeviceApi apiInstance = new DeviceApi();
        String deviceName = deviceName_example; // String | The name of the device (e.g. S7 1212C DC), which could also be an abstract device (e.g. Welding 247)
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        String physicalQuantity = physicalQuantity_example; // String | The physical quantity that is measured at a device
        try {
            deviceCollection result = apiInstance.getDevices(deviceName, limit, offset, physicalQuantity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceApi#getDevices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *deviceName = deviceName_example; // The name of the device (e.g. S7 1212C DC), which could also be an abstract device (e.g. Welding 247) (optional)
Integer *limit = 56; // Size of the requested page (optional) (default to 100)
Integer *offset = 56; // Offset used for pagination (optional) (default to 0)
String *physicalQuantity = physicalQuantity_example; // The physical quantity that is measured at a device (optional)

DeviceApi *apiInstance = [[DeviceApi alloc] init];

// Retrieve all devices.
[apiInstance getDevicesWith:deviceName
    limit:limit
    offset:offset
    physicalQuantity:physicalQuantity
              completionHandler: ^(deviceCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.DeviceApi()

var opts = { 
  'deviceName': deviceName_example, // {String} The name of the device (e.g. S7 1212C DC), which could also be an abstract device (e.g. Welding 247)
  'limit': 56, // {Integer} Size of the requested page
  'offset': 56, // {Integer} Offset used for pagination
  'physicalQuantity': physicalQuantity_example // {String} The physical quantity that is measured at a device
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDevices(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDevicesExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeviceApi();
            var deviceName = deviceName_example;  // String | The name of the device (e.g. S7 1212C DC), which could also be an abstract device (e.g. Welding 247) (optional) 
            var limit = 56;  // Integer | Size of the requested page (optional)  (default to 100)
            var offset = 56;  // Integer | Offset used for pagination (optional)  (default to 0)
            var physicalQuantity = physicalQuantity_example;  // String | The physical quantity that is measured at a device (optional) 

            try
            {
                // Retrieve all devices.
                deviceCollection result = apiInstance.getDevices(deviceName, limit, offset, physicalQuantity);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceApi.getDevices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DeviceApi();
$deviceName = deviceName_example; // String | The name of the device (e.g. S7 1212C DC), which could also be an abstract device (e.g. Welding 247)
$limit = 56; // Integer | Size of the requested page
$offset = 56; // Integer | Offset used for pagination
$physicalQuantity = physicalQuantity_example; // String | The physical quantity that is measured at a device

try {
    $result = $api_instance->getDevices($deviceName, $limit, $offset, $physicalQuantity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeviceApi->getDevices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeviceApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DeviceApi->new();
my $deviceName = deviceName_example; # String | The name of the device (e.g. S7 1212C DC), which could also be an abstract device (e.g. Welding 247)
my $limit = 56; # Integer | Size of the requested page
my $offset = 56; # Integer | Offset used for pagination
my $physicalQuantity = physicalQuantity_example; # String | The physical quantity that is measured at a device

eval { 
    my $result = $api_instance->getDevices(deviceName => $deviceName, limit => $limit, offset => $offset, physicalQuantity => $physicalQuantity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeviceApi->getDevices: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DeviceApi()
deviceName = deviceName_example # String | The name of the device (e.g. S7 1212C DC), which could also be an abstract device (e.g. Welding 247) (optional)
limit = 56 # Integer | Size of the requested page (optional) (default to 100)
offset = 56 # Integer | Offset used for pagination (optional) (default to 0)
physicalQuantity = physicalQuantity_example # String | The physical quantity that is measured at a device (optional)

try: 
    # Retrieve all devices.
    api_response = api_instance.get_devices(deviceName=deviceName, limit=limit, offset=offset, physicalQuantity=physicalQuantity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->getDevices: %s\n" % e)

Parameters

Query parameters
Name Description
deviceName
String
The name of the device (e.g. S7 1212C DC), which could also be an abstract device (e.g. Welding 247)
limit
Integer (int32)
Size of the requested page
offset
Integer (int32)
Offset used for pagination
physicalQuantity
String
The physical quantity that is measured at a device

Responses

Status: 200 - Collection of devices found

Status: 400 - Collection of devices not found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 500 - Internal server error

Status: 502 - Received subservice error.


getRecordedTimeSeries

Retrieve the recorded time series of a device.

A filtered list of recorded time series is returned. Call parameters allow filtering according to a specific time period. If the device is the programmable logic controller of a machine or a virtual device that combines several programmable logic controllers of a machine, the time series represent the recorded process parameters. In this case, it is also possible to filter according to a specific operation that was executed on the machine.


/devices/{deviceId}/recordedTimeSeries

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/devices/{deviceId}/recordedTimeSeries?endDate=&limit=&materialNumber=&operationNumber=&paginationDirection=&paginationTimestamp=&productionOrderNumber=&startDate=&tag=&workplaceId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceApi;

import java.io.File;
import java.util.*;

public class DeviceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        DeviceApi apiInstance = new DeviceApi();
        String deviceId = deviceId_example; // String | UUID of a device
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period. Default value: current time
        Integer limit = 56; // Integer | Size of the requested page
        String materialNumber = materialNumber_example; // String | Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period
        String operationNumber = operationNumber_example; // String | Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period
        String paginationDirection = paginationDirection_example; // String | Direction on how to navigate through the response pages
        Date paginationTimestamp = 2013-10-20T19:20:30+01:00; // Date | Timestamp used for pagination
        String productionOrderNumber = productionOrderNumber_example; // String | Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period
        Long tag = 789; // Long | Tag for a specific variable or process parameter
        String workplaceId = workplaceId_example; // String | UUID of the workplace.
        try {
            deviceRecordedTimeSeriesCollection result = apiInstance.getRecordedTimeSeries(deviceId, endDate, limit, materialNumber, operationNumber, paginationDirection, paginationTimestamp, productionOrderNumber, startDate, tag, workplaceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceApi#getRecordedTimeSeries");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeviceApi;

public class DeviceApiExample {

    public static void main(String[] args) {
        DeviceApi apiInstance = new DeviceApi();
        String deviceId = deviceId_example; // String | UUID of a device
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period. Default value: current time
        Integer limit = 56; // Integer | Size of the requested page
        String materialNumber = materialNumber_example; // String | Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period
        String operationNumber = operationNumber_example; // String | Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period
        String paginationDirection = paginationDirection_example; // String | Direction on how to navigate through the response pages
        Date paginationTimestamp = 2013-10-20T19:20:30+01:00; // Date | Timestamp used for pagination
        String productionOrderNumber = productionOrderNumber_example; // String | Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period
        Long tag = 789; // Long | Tag for a specific variable or process parameter
        String workplaceId = workplaceId_example; // String | UUID of the workplace.
        try {
            deviceRecordedTimeSeriesCollection result = apiInstance.getRecordedTimeSeries(deviceId, endDate, limit, materialNumber, operationNumber, paginationDirection, paginationTimestamp, productionOrderNumber, startDate, tag, workplaceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceApi#getRecordedTimeSeries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *deviceId = deviceId_example; // UUID of a device
Date *endDate = 2013-10-20T19:20:30+01:00; // The end date of the considered period. Default value: current time (optional)
Integer *limit = 56; // Size of the requested page (optional) (default to 100)
String *materialNumber = materialNumber_example; // Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period (optional)
String *operationNumber = operationNumber_example; // Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period (optional)
String *paginationDirection = paginationDirection_example; // Direction on how to navigate through the response pages (optional) (default to NEXT)
Date *paginationTimestamp = 2013-10-20T19:20:30+01:00; // Timestamp used for pagination (optional)
String *productionOrderNumber = productionOrderNumber_example; // Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period (optional)
Date *startDate = 2013-10-20T19:20:30+01:00; // The start date of the considered period (optional) (default to Beginning of the current week)
Long *tag = 789; // Tag for a specific variable or process parameter (optional)
String *workplaceId = workplaceId_example; // UUID of the workplace. (optional)

DeviceApi *apiInstance = [[DeviceApi alloc] init];

// Retrieve the recorded time series of a device.
[apiInstance getRecordedTimeSeriesWith:deviceId
    endDate:endDate
    limit:limit
    materialNumber:materialNumber
    operationNumber:operationNumber
    paginationDirection:paginationDirection
    paginationTimestamp:paginationTimestamp
    productionOrderNumber:productionOrderNumber
    startDate:startDate
    tag:tag
    workplaceId:workplaceId
              completionHandler: ^(deviceRecordedTimeSeriesCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.DeviceApi()

var deviceId = deviceId_example; // {String} UUID of a device

var opts = { 
  'endDate': 2013-10-20T19:20:30+01:00, // {Date} The end date of the considered period. Default value: current time
  'limit': 56, // {Integer} Size of the requested page
  'materialNumber': materialNumber_example, // {String} Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period
  'operationNumber': operationNumber_example, // {String} Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period
  'paginationDirection': paginationDirection_example, // {String} Direction on how to navigate through the response pages
  'paginationTimestamp': 2013-10-20T19:20:30+01:00, // {Date} Timestamp used for pagination
  'productionOrderNumber': productionOrderNumber_example, // {String} Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period
  'startDate': 2013-10-20T19:20:30+01:00, // {Date} The start date of the considered period
  'tag': 789, // {Long} Tag for a specific variable or process parameter
  'workplaceId': workplaceId_example // {String} UUID of the workplace.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRecordedTimeSeries(deviceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRecordedTimeSeriesExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeviceApi();
            var deviceId = deviceId_example;  // String | UUID of a device
            var endDate = 2013-10-20T19:20:30+01:00;  // Date | The end date of the considered period. Default value: current time (optional) 
            var limit = 56;  // Integer | Size of the requested page (optional)  (default to 100)
            var materialNumber = materialNumber_example;  // String | Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period (optional) 
            var operationNumber = operationNumber_example;  // String | Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period (optional) 
            var paginationDirection = paginationDirection_example;  // String | Direction on how to navigate through the response pages (optional)  (default to NEXT)
            var paginationTimestamp = 2013-10-20T19:20:30+01:00;  // Date | Timestamp used for pagination (optional) 
            var productionOrderNumber = productionOrderNumber_example;  // String | Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period (optional) 
            var startDate = 2013-10-20T19:20:30+01:00;  // Date | The start date of the considered period (optional)  (default to Beginning of the current week)
            var tag = 789;  // Long | Tag for a specific variable or process parameter (optional) 
            var workplaceId = workplaceId_example;  // String | UUID of the workplace. (optional) 

            try
            {
                // Retrieve the recorded time series of a device.
                deviceRecordedTimeSeriesCollection result = apiInstance.getRecordedTimeSeries(deviceId, endDate, limit, materialNumber, operationNumber, paginationDirection, paginationTimestamp, productionOrderNumber, startDate, tag, workplaceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceApi.getRecordedTimeSeries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DeviceApi();
$deviceId = deviceId_example; // String | UUID of a device
$endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period. Default value: current time
$limit = 56; // Integer | Size of the requested page
$materialNumber = materialNumber_example; // String | Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period
$operationNumber = operationNumber_example; // String | Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period
$paginationDirection = paginationDirection_example; // String | Direction on how to navigate through the response pages
$paginationTimestamp = 2013-10-20T19:20:30+01:00; // Date | Timestamp used for pagination
$productionOrderNumber = productionOrderNumber_example; // String | Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period
$startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period
$tag = 789; // Long | Tag for a specific variable or process parameter
$workplaceId = workplaceId_example; // String | UUID of the workplace.

try {
    $result = $api_instance->getRecordedTimeSeries($deviceId, $endDate, $limit, $materialNumber, $operationNumber, $paginationDirection, $paginationTimestamp, $productionOrderNumber, $startDate, $tag, $workplaceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeviceApi->getRecordedTimeSeries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeviceApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DeviceApi->new();
my $deviceId = deviceId_example; # String | UUID of a device
my $endDate = 2013-10-20T19:20:30+01:00; # Date | The end date of the considered period. Default value: current time
my $limit = 56; # Integer | Size of the requested page
my $materialNumber = materialNumber_example; # String | Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period
my $operationNumber = operationNumber_example; # String | Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period
my $paginationDirection = paginationDirection_example; # String | Direction on how to navigate through the response pages
my $paginationTimestamp = 2013-10-20T19:20:30+01:00; # Date | Timestamp used for pagination
my $productionOrderNumber = productionOrderNumber_example; # String | Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period
my $startDate = 2013-10-20T19:20:30+01:00; # Date | The start date of the considered period
my $tag = 789; # Long | Tag for a specific variable or process parameter
my $workplaceId = workplaceId_example; # String | UUID of the workplace.

eval { 
    my $result = $api_instance->getRecordedTimeSeries(deviceId => $deviceId, endDate => $endDate, limit => $limit, materialNumber => $materialNumber, operationNumber => $operationNumber, paginationDirection => $paginationDirection, paginationTimestamp => $paginationTimestamp, productionOrderNumber => $productionOrderNumber, startDate => $startDate, tag => $tag, workplaceId => $workplaceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeviceApi->getRecordedTimeSeries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DeviceApi()
deviceId = deviceId_example # String | UUID of a device
endDate = 2013-10-20T19:20:30+01:00 # Date | The end date of the considered period. Default value: current time (optional)
limit = 56 # Integer | Size of the requested page (optional) (default to 100)
materialNumber = materialNumber_example # String | Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period (optional)
operationNumber = operationNumber_example # String | Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period (optional)
paginationDirection = paginationDirection_example # String | Direction on how to navigate through the response pages (optional) (default to NEXT)
paginationTimestamp = 2013-10-20T19:20:30+01:00 # Date | Timestamp used for pagination (optional)
productionOrderNumber = productionOrderNumber_example # String | Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period (optional)
startDate = 2013-10-20T19:20:30+01:00 # Date | The start date of the considered period (optional) (default to Beginning of the current week)
tag = 789 # Long | Tag for a specific variable or process parameter (optional)
workplaceId = workplaceId_example # String | UUID of the workplace. (optional)

try: 
    # Retrieve the recorded time series of a device.
    api_response = api_instance.get_recorded_time_series(deviceId, endDate=endDate, limit=limit, materialNumber=materialNumber, operationNumber=operationNumber, paginationDirection=paginationDirection, paginationTimestamp=paginationTimestamp, productionOrderNumber=productionOrderNumber, startDate=startDate, tag=tag, workplaceId=workplaceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceApi->getRecordedTimeSeries: %s\n" % e)

Parameters

Path parameters
Name Description
deviceId*
String
UUID of a device
Required
Query parameters
Name Description
endDate
Date (date-time)
The end date of the considered period. Default value: current time
limit
Integer (int32)
Size of the requested page
materialNumber
String
Material number of a material produced. To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period
operationNumber
String
Operation number of an executed operation. To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period
paginationDirection
String
Direction on how to navigate through the response pages
paginationTimestamp
Date (date-time)
Timestamp used for pagination
productionOrderNumber
String
Production Order number of an executed production order. To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period
startDate
Date (date-time)
The start date of the considered period
tag
Long (int64)
Tag for a specific variable or process parameter
workplaceId
String
UUID of the workplace.

Responses

Status: 200 - Recorded time series of a device found

Status: 400 - Unable to find the device time series for the given deviceId parameter.

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 500 - Internal server error

Status: 502 - Received subservice error.


MasterData

getOperatingState

Retrieve an operating state.

Operating states can be arbitrarily defined in any production site and assigned to one or more of the following time bases: SCHEDULED_OPERATING_TIME, PRODUCTION, SETUP, MALFUNCTION and MAINTENANCE. The assignment of the operating states to these time bases determines the calculation of various key performance indicators.


/masterData/operatingStates/{operatingStateId}

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/masterData/operatingStates/{operatingStateId}?embed="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MasterDataApi;

import java.io.File;
import java.util.*;

public class MasterDataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MasterDataApi apiInstance = new MasterDataApi();
        String operatingStateId = operatingStateId_example; // String | UUID of an operating state
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        try {
            operatingState result = apiInstance.getOperatingState(operatingStateId, embed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MasterDataApi#getOperatingState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MasterDataApi;

public class MasterDataApiExample {

    public static void main(String[] args) {
        MasterDataApi apiInstance = new MasterDataApi();
        String operatingStateId = operatingStateId_example; // String | UUID of an operating state
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        try {
            operatingState result = apiInstance.getOperatingState(operatingStateId, embed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MasterDataApi#getOperatingState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *operatingStateId = operatingStateId_example; // UUID of an operating state
array[String] *embed = ; // Names of embeddable resources to be embedded (optional)

MasterDataApi *apiInstance = [[MasterDataApi alloc] init];

// Retrieve an operating state.
[apiInstance getOperatingStateWith:operatingStateId
    embed:embed
              completionHandler: ^(operatingState output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.MasterDataApi()

var operatingStateId = operatingStateId_example; // {String} UUID of an operating state

var opts = { 
  'embed':  // {array[String]} Names of embeddable resources to be embedded
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOperatingState(operatingStateId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOperatingStateExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MasterDataApi();
            var operatingStateId = operatingStateId_example;  // String | UUID of an operating state
            var embed = new array[String](); // array[String] | Names of embeddable resources to be embedded (optional) 

            try
            {
                // Retrieve an operating state.
                operatingState result = apiInstance.getOperatingState(operatingStateId, embed);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterDataApi.getOperatingState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\MasterDataApi();
$operatingStateId = operatingStateId_example; // String | UUID of an operating state
$embed = ; // array[String] | Names of embeddable resources to be embedded

try {
    $result = $api_instance->getOperatingState($operatingStateId, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MasterDataApi->getOperatingState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MasterDataApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MasterDataApi->new();
my $operatingStateId = operatingStateId_example; # String | UUID of an operating state
my $embed = []; # array[String] | Names of embeddable resources to be embedded

eval { 
    my $result = $api_instance->getOperatingState(operatingStateId => $operatingStateId, embed => $embed);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MasterDataApi->getOperatingState: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MasterDataApi()
operatingStateId = operatingStateId_example # String | UUID of an operating state
embed =  # array[String] | Names of embeddable resources to be embedded (optional)

try: 
    # Retrieve an operating state.
    api_response = api_instance.get_operating_state(operatingStateId, embed=embed)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MasterDataApi->getOperatingState: %s\n" % e)

Parameters

Path parameters
Name Description
operatingStateId*
String
UUID of an operating state
Required
Query parameters
Name Description
embed
array[String]
Names of embeddable resources to be embedded

Responses

Status: 200 - Operating state found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 404 - Unable to find operating state for the given operatingStateId parameter.

Status: 500 - Internal server error


getOperatingStates

Retrieve the collection of operating states.


/masterData/operatingStates

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/masterData/operatingStates?embed=&limit=&offset=&timeBase=&workplaceStateId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MasterDataApi;

import java.io.File;
import java.util.*;

public class MasterDataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MasterDataApi apiInstance = new MasterDataApi();
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        String timeBase = timeBase_example; // String | Time base to be filtered for
        String workplaceStateId = workplaceStateId_example; // String | ID of a workplace state
        try {
            operatingStateCollection result = apiInstance.getOperatingStates(embed, limit, offset, timeBase, workplaceStateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MasterDataApi#getOperatingStates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MasterDataApi;

public class MasterDataApiExample {

    public static void main(String[] args) {
        MasterDataApi apiInstance = new MasterDataApi();
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        String timeBase = timeBase_example; // String | Time base to be filtered for
        String workplaceStateId = workplaceStateId_example; // String | ID of a workplace state
        try {
            operatingStateCollection result = apiInstance.getOperatingStates(embed, limit, offset, timeBase, workplaceStateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MasterDataApi#getOperatingStates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

array[String] *embed = ; // Names of embeddable resources to be embedded (optional)
Integer *limit = 56; // Size of the requested page (optional) (default to 100)
Integer *offset = 56; // Offset used for pagination (optional) (default to 0)
String *timeBase = timeBase_example; // Time base to be filtered for (optional)
String *workplaceStateId = workplaceStateId_example; // ID of a workplace state (optional)

MasterDataApi *apiInstance = [[MasterDataApi alloc] init];

// Retrieve the collection of operating states.
[apiInstance getOperatingStatesWith:embed
    limit:limit
    offset:offset
    timeBase:timeBase
    workplaceStateId:workplaceStateId
              completionHandler: ^(operatingStateCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.MasterDataApi()

var opts = { 
  'embed': , // {array[String]} Names of embeddable resources to be embedded
  'limit': 56, // {Integer} Size of the requested page
  'offset': 56, // {Integer} Offset used for pagination
  'timeBase': timeBase_example, // {String} Time base to be filtered for
  'workplaceStateId': workplaceStateId_example // {String} ID of a workplace state
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOperatingStates(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOperatingStatesExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MasterDataApi();
            var embed = new array[String](); // array[String] | Names of embeddable resources to be embedded (optional) 
            var limit = 56;  // Integer | Size of the requested page (optional)  (default to 100)
            var offset = 56;  // Integer | Offset used for pagination (optional)  (default to 0)
            var timeBase = timeBase_example;  // String | Time base to be filtered for (optional) 
            var workplaceStateId = workplaceStateId_example;  // String | ID of a workplace state (optional) 

            try
            {
                // Retrieve the collection of operating states.
                operatingStateCollection result = apiInstance.getOperatingStates(embed, limit, offset, timeBase, workplaceStateId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterDataApi.getOperatingStates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\MasterDataApi();
$embed = ; // array[String] | Names of embeddable resources to be embedded
$limit = 56; // Integer | Size of the requested page
$offset = 56; // Integer | Offset used for pagination
$timeBase = timeBase_example; // String | Time base to be filtered for
$workplaceStateId = workplaceStateId_example; // String | ID of a workplace state

try {
    $result = $api_instance->getOperatingStates($embed, $limit, $offset, $timeBase, $workplaceStateId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MasterDataApi->getOperatingStates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MasterDataApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MasterDataApi->new();
my $embed = []; # array[String] | Names of embeddable resources to be embedded
my $limit = 56; # Integer | Size of the requested page
my $offset = 56; # Integer | Offset used for pagination
my $timeBase = timeBase_example; # String | Time base to be filtered for
my $workplaceStateId = workplaceStateId_example; # String | ID of a workplace state

eval { 
    my $result = $api_instance->getOperatingStates(embed => $embed, limit => $limit, offset => $offset, timeBase => $timeBase, workplaceStateId => $workplaceStateId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MasterDataApi->getOperatingStates: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MasterDataApi()
embed =  # array[String] | Names of embeddable resources to be embedded (optional)
limit = 56 # Integer | Size of the requested page (optional) (default to 100)
offset = 56 # Integer | Offset used for pagination (optional) (default to 0)
timeBase = timeBase_example # String | Time base to be filtered for (optional)
workplaceStateId = workplaceStateId_example # String | ID of a workplace state (optional)

try: 
    # Retrieve the collection of operating states.
    api_response = api_instance.get_operating_states(embed=embed, limit=limit, offset=offset, timeBase=timeBase, workplaceStateId=workplaceStateId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MasterDataApi->getOperatingStates: %s\n" % e)

Parameters

Query parameters
Name Description
embed
array[String]
Names of embeddable resources to be embedded
limit
Integer (int32)
Size of the requested page
offset
Integer (int32)
Offset used for pagination
timeBase
String
Time base to be filtered for
workplaceStateId
String
ID of a workplace state

Responses

Status: 200 - Operating states collection found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 500 - Internal server error


getQualityDetail

Retrieve a quality detail.

The quality details are used to describe the quality types YIELD, SCRAP and REWORK more precisely or to justify the assignment to one of these quality types.


/masterData/qualityDetails/{qualityDetailId}

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/masterData/qualityDetails/{qualityDetailId}?embed="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MasterDataApi;

import java.io.File;
import java.util.*;

public class MasterDataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MasterDataApi apiInstance = new MasterDataApi();
        String qualityDetailId = qualityDetailId_example; // String | UUID of a quality detail
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        try {
            qualityDetail result = apiInstance.getQualityDetail(qualityDetailId, embed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MasterDataApi#getQualityDetail");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MasterDataApi;

public class MasterDataApiExample {

    public static void main(String[] args) {
        MasterDataApi apiInstance = new MasterDataApi();
        String qualityDetailId = qualityDetailId_example; // String | UUID of a quality detail
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        try {
            qualityDetail result = apiInstance.getQualityDetail(qualityDetailId, embed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MasterDataApi#getQualityDetail");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *qualityDetailId = qualityDetailId_example; // UUID of a quality detail
array[String] *embed = ; // Names of embeddable resources to be embedded (optional)

MasterDataApi *apiInstance = [[MasterDataApi alloc] init];

// Retrieve a quality detail.
[apiInstance getQualityDetailWith:qualityDetailId
    embed:embed
              completionHandler: ^(qualityDetail output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.MasterDataApi()

var qualityDetailId = qualityDetailId_example; // {String} UUID of a quality detail

var opts = { 
  'embed':  // {array[String]} Names of embeddable resources to be embedded
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQualityDetail(qualityDetailId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getQualityDetailExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MasterDataApi();
            var qualityDetailId = qualityDetailId_example;  // String | UUID of a quality detail
            var embed = new array[String](); // array[String] | Names of embeddable resources to be embedded (optional) 

            try
            {
                // Retrieve a quality detail.
                qualityDetail result = apiInstance.getQualityDetail(qualityDetailId, embed);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterDataApi.getQualityDetail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\MasterDataApi();
$qualityDetailId = qualityDetailId_example; // String | UUID of a quality detail
$embed = ; // array[String] | Names of embeddable resources to be embedded

try {
    $result = $api_instance->getQualityDetail($qualityDetailId, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MasterDataApi->getQualityDetail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MasterDataApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MasterDataApi->new();
my $qualityDetailId = qualityDetailId_example; # String | UUID of a quality detail
my $embed = []; # array[String] | Names of embeddable resources to be embedded

eval { 
    my $result = $api_instance->getQualityDetail(qualityDetailId => $qualityDetailId, embed => $embed);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MasterDataApi->getQualityDetail: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MasterDataApi()
qualityDetailId = qualityDetailId_example # String | UUID of a quality detail
embed =  # array[String] | Names of embeddable resources to be embedded (optional)

try: 
    # Retrieve a quality detail.
    api_response = api_instance.get_quality_detail(qualityDetailId, embed=embed)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MasterDataApi->getQualityDetail: %s\n" % e)

Parameters

Path parameters
Name Description
qualityDetailId*
String
UUID of a quality detail
Required
Query parameters
Name Description
embed
array[String]
Names of embeddable resources to be embedded

Responses

Status: 200 - Quality details found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 404 - Unable to find quality detail for the given qualityDetailId parameter.

Status: 500 - Internal server error


getQualityDetails

Retrieve the collection of quality details.


/masterData/qualityDetails

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/masterData/qualityDetails?code=&embed=&limit=&offset=&qualityTypeId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MasterDataApi;

import java.io.File;
import java.util.*;

public class MasterDataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MasterDataApi apiInstance = new MasterDataApi();
        String code = code_example; // String | The code assigned to the quality detail
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        String qualityTypeId = qualityTypeId_example; // String | ID of the corresponding quality type
        try {
            qualityDetailCollection result = apiInstance.getQualityDetails(code, embed, limit, offset, qualityTypeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MasterDataApi#getQualityDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MasterDataApi;

public class MasterDataApiExample {

    public static void main(String[] args) {
        MasterDataApi apiInstance = new MasterDataApi();
        String code = code_example; // String | The code assigned to the quality detail
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        String qualityTypeId = qualityTypeId_example; // String | ID of the corresponding quality type
        try {
            qualityDetailCollection result = apiInstance.getQualityDetails(code, embed, limit, offset, qualityTypeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MasterDataApi#getQualityDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *code = code_example; // The code assigned to the quality detail (optional)
array[String] *embed = ; // Names of embeddable resources to be embedded (optional)
Integer *limit = 56; // Size of the requested page (optional) (default to 100)
Integer *offset = 56; // Offset used for pagination (optional) (default to 0)
String *qualityTypeId = qualityTypeId_example; // ID of the corresponding quality type (optional)

MasterDataApi *apiInstance = [[MasterDataApi alloc] init];

// Retrieve the collection of quality details.
[apiInstance getQualityDetailsWith:code
    embed:embed
    limit:limit
    offset:offset
    qualityTypeId:qualityTypeId
              completionHandler: ^(qualityDetailCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.MasterDataApi()

var opts = { 
  'code': code_example, // {String} The code assigned to the quality detail
  'embed': , // {array[String]} Names of embeddable resources to be embedded
  'limit': 56, // {Integer} Size of the requested page
  'offset': 56, // {Integer} Offset used for pagination
  'qualityTypeId': qualityTypeId_example // {String} ID of the corresponding quality type
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQualityDetails(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getQualityDetailsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MasterDataApi();
            var code = code_example;  // String | The code assigned to the quality detail (optional) 
            var embed = new array[String](); // array[String] | Names of embeddable resources to be embedded (optional) 
            var limit = 56;  // Integer | Size of the requested page (optional)  (default to 100)
            var offset = 56;  // Integer | Offset used for pagination (optional)  (default to 0)
            var qualityTypeId = qualityTypeId_example;  // String | ID of the corresponding quality type (optional) 

            try
            {
                // Retrieve the collection of quality details.
                qualityDetailCollection result = apiInstance.getQualityDetails(code, embed, limit, offset, qualityTypeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterDataApi.getQualityDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\MasterDataApi();
$code = code_example; // String | The code assigned to the quality detail
$embed = ; // array[String] | Names of embeddable resources to be embedded
$limit = 56; // Integer | Size of the requested page
$offset = 56; // Integer | Offset used for pagination
$qualityTypeId = qualityTypeId_example; // String | ID of the corresponding quality type

try {
    $result = $api_instance->getQualityDetails($code, $embed, $limit, $offset, $qualityTypeId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MasterDataApi->getQualityDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MasterDataApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MasterDataApi->new();
my $code = code_example; # String | The code assigned to the quality detail
my $embed = []; # array[String] | Names of embeddable resources to be embedded
my $limit = 56; # Integer | Size of the requested page
my $offset = 56; # Integer | Offset used for pagination
my $qualityTypeId = qualityTypeId_example; # String | ID of the corresponding quality type

eval { 
    my $result = $api_instance->getQualityDetails(code => $code, embed => $embed, limit => $limit, offset => $offset, qualityTypeId => $qualityTypeId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MasterDataApi->getQualityDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MasterDataApi()
code = code_example # String | The code assigned to the quality detail (optional)
embed =  # array[String] | Names of embeddable resources to be embedded (optional)
limit = 56 # Integer | Size of the requested page (optional) (default to 100)
offset = 56 # Integer | Offset used for pagination (optional) (default to 0)
qualityTypeId = qualityTypeId_example # String | ID of the corresponding quality type (optional)

try: 
    # Retrieve the collection of quality details.
    api_response = api_instance.get_quality_details(code=code, embed=embed, limit=limit, offset=offset, qualityTypeId=qualityTypeId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MasterDataApi->getQualityDetails: %s\n" % e)

Parameters

Query parameters
Name Description
code
String
The code assigned to the quality detail
embed
array[String]
Names of embeddable resources to be embedded
limit
Integer (int32)
Size of the requested page
offset
Integer (int32)
Offset used for pagination
qualityTypeId
String
ID of the corresponding quality type

Responses

Status: 200 - Quality detail collection found

Status: 400 - Invalid qualityTypeId provided.

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 500 - Internal server error


getQualityType

Retrieve a quality type.

The quality type classifies the output quantity of a workplace into YIELD, SCRAP or REWORK. Among other things, this qualification is used to determine the quality rate.


/masterData/qualityTypes/{qualityTypeId}

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/masterData/qualityTypes/{qualityTypeId}?embed="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MasterDataApi;

import java.io.File;
import java.util.*;

public class MasterDataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MasterDataApi apiInstance = new MasterDataApi();
        String qualityTypeId = qualityTypeId_example; // String | ID of a quality type
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        try {
            qualityType result = apiInstance.getQualityType(qualityTypeId, embed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MasterDataApi#getQualityType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MasterDataApi;

public class MasterDataApiExample {

    public static void main(String[] args) {
        MasterDataApi apiInstance = new MasterDataApi();
        String qualityTypeId = qualityTypeId_example; // String | ID of a quality type
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        try {
            qualityType result = apiInstance.getQualityType(qualityTypeId, embed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MasterDataApi#getQualityType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *qualityTypeId = qualityTypeId_example; // ID of a quality type
array[String] *embed = ; // Names of embeddable resources to be embedded (optional)

MasterDataApi *apiInstance = [[MasterDataApi alloc] init];

// Retrieve a quality type.
[apiInstance getQualityTypeWith:qualityTypeId
    embed:embed
              completionHandler: ^(qualityType output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.MasterDataApi()

var qualityTypeId = qualityTypeId_example; // {String} ID of a quality type

var opts = { 
  'embed':  // {array[String]} Names of embeddable resources to be embedded
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQualityType(qualityTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getQualityTypeExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MasterDataApi();
            var qualityTypeId = qualityTypeId_example;  // String | ID of a quality type
            var embed = new array[String](); // array[String] | Names of embeddable resources to be embedded (optional) 

            try
            {
                // Retrieve a quality type.
                qualityType result = apiInstance.getQualityType(qualityTypeId, embed);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterDataApi.getQualityType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\MasterDataApi();
$qualityTypeId = qualityTypeId_example; // String | ID of a quality type
$embed = ; // array[String] | Names of embeddable resources to be embedded

try {
    $result = $api_instance->getQualityType($qualityTypeId, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MasterDataApi->getQualityType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MasterDataApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MasterDataApi->new();
my $qualityTypeId = qualityTypeId_example; # String | ID of a quality type
my $embed = []; # array[String] | Names of embeddable resources to be embedded

eval { 
    my $result = $api_instance->getQualityType(qualityTypeId => $qualityTypeId, embed => $embed);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MasterDataApi->getQualityType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MasterDataApi()
qualityTypeId = qualityTypeId_example # String | ID of a quality type
embed =  # array[String] | Names of embeddable resources to be embedded (optional)

try: 
    # Retrieve a quality type.
    api_response = api_instance.get_quality_type(qualityTypeId, embed=embed)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MasterDataApi->getQualityType: %s\n" % e)

Parameters

Path parameters
Name Description
qualityTypeId*
String
ID of a quality type
Required
Query parameters
Name Description
embed
array[String]
Names of embeddable resources to be embedded

Responses

Status: 200 - Quality type found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 404 - Unable to find the quality type for the given qualityTypeId parameter.

Status: 500 - Internal server error


getQualityTypes

Retrieve the collection of quality types.


/masterData/qualityTypes

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/masterData/qualityTypes?embed=&limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MasterDataApi;

import java.io.File;
import java.util.*;

public class MasterDataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        MasterDataApi apiInstance = new MasterDataApi();
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        try {
            qualityTypes result = apiInstance.getQualityTypes(embed, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MasterDataApi#getQualityTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MasterDataApi;

public class MasterDataApiExample {

    public static void main(String[] args) {
        MasterDataApi apiInstance = new MasterDataApi();
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        try {
            qualityTypes result = apiInstance.getQualityTypes(embed, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MasterDataApi#getQualityTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

array[String] *embed = ; // Names of embeddable resources to be embedded (optional)
Integer *limit = 56; // Size of the requested page (optional) (default to 100)
Integer *offset = 56; // Offset used for pagination (optional) (default to 0)

MasterDataApi *apiInstance = [[MasterDataApi alloc] init];

// Retrieve the collection of quality types.
[apiInstance getQualityTypesWith:embed
    limit:limit
    offset:offset
              completionHandler: ^(qualityTypes output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.MasterDataApi()

var opts = { 
  'embed': , // {array[String]} Names of embeddable resources to be embedded
  'limit': 56, // {Integer} Size of the requested page
  'offset': 56 // {Integer} Offset used for pagination
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getQualityTypes(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getQualityTypesExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MasterDataApi();
            var embed = new array[String](); // array[String] | Names of embeddable resources to be embedded (optional) 
            var limit = 56;  // Integer | Size of the requested page (optional)  (default to 100)
            var offset = 56;  // Integer | Offset used for pagination (optional)  (default to 0)

            try
            {
                // Retrieve the collection of quality types.
                qualityTypes result = apiInstance.getQualityTypes(embed, limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MasterDataApi.getQualityTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\MasterDataApi();
$embed = ; // array[String] | Names of embeddable resources to be embedded
$limit = 56; // Integer | Size of the requested page
$offset = 56; // Integer | Offset used for pagination

try {
    $result = $api_instance->getQualityTypes($embed, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MasterDataApi->getQualityTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MasterDataApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MasterDataApi->new();
my $embed = []; # array[String] | Names of embeddable resources to be embedded
my $limit = 56; # Integer | Size of the requested page
my $offset = 56; # Integer | Offset used for pagination

eval { 
    my $result = $api_instance->getQualityTypes(embed => $embed, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MasterDataApi->getQualityTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MasterDataApi()
embed =  # array[String] | Names of embeddable resources to be embedded (optional)
limit = 56 # Integer | Size of the requested page (optional) (default to 100)
offset = 56 # Integer | Offset used for pagination (optional) (default to 0)

try: 
    # Retrieve the collection of quality types.
    api_response = api_instance.get_quality_types(embed=embed, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MasterDataApi->getQualityTypes: %s\n" % e)

Parameters

Query parameters
Name Description
embed
array[String]
Names of embeddable resources to be embedded
limit
Integer (int32)
Size of the requested page
offset
Integer (int32)
Offset used for pagination

Responses

Status: 200 - Quality type collection found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 500 - Internal server error


Workplace

getWorkplace

Retrieve a workplace.

Information is returned for domain-specific identification of the workplace and about its current state. Information on the operations that are currently being executed at the workplace can be embedded (embed=currentOperations). In addition, most sub-resources of the workplace can be embedded.


/workplaces/{workplaceId}

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/workplaces/{workplaceId}?embed="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkplaceApi;

import java.io.File;
import java.util.*;

public class WorkplaceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        WorkplaceApi apiInstance = new WorkplaceApi();
        String workplaceId = workplaceId_example; // String | UUID of a workplace
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        try {
            workplace result = apiInstance.getWorkplace(workplaceId, embed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceApi#getWorkplace");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkplaceApi;

public class WorkplaceApiExample {

    public static void main(String[] args) {
        WorkplaceApi apiInstance = new WorkplaceApi();
        String workplaceId = workplaceId_example; // String | UUID of a workplace
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        try {
            workplace result = apiInstance.getWorkplace(workplaceId, embed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceApi#getWorkplace");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *workplaceId = workplaceId_example; // UUID of a workplace
array[String] *embed = ; // Names of embeddable resources to be embedded (optional)

WorkplaceApi *apiInstance = [[WorkplaceApi alloc] init];

// Retrieve a workplace.
[apiInstance getWorkplaceWith:workplaceId
    embed:embed
              completionHandler: ^(workplace output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.WorkplaceApi()

var workplaceId = workplaceId_example; // {String} UUID of a workplace

var opts = { 
  'embed':  // {array[String]} Names of embeddable resources to be embedded
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWorkplace(workplaceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getWorkplaceExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WorkplaceApi();
            var workplaceId = workplaceId_example;  // String | UUID of a workplace
            var embed = new array[String](); // array[String] | Names of embeddable resources to be embedded (optional) 

            try
            {
                // Retrieve a workplace.
                workplace result = apiInstance.getWorkplace(workplaceId, embed);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkplaceApi.getWorkplace: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\WorkplaceApi();
$workplaceId = workplaceId_example; // String | UUID of a workplace
$embed = ; // array[String] | Names of embeddable resources to be embedded

try {
    $result = $api_instance->getWorkplace($workplaceId, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkplaceApi->getWorkplace: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkplaceApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WorkplaceApi->new();
my $workplaceId = workplaceId_example; # String | UUID of a workplace
my $embed = []; # array[String] | Names of embeddable resources to be embedded

eval { 
    my $result = $api_instance->getWorkplace(workplaceId => $workplaceId, embed => $embed);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkplaceApi->getWorkplace: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WorkplaceApi()
workplaceId = workplaceId_example # String | UUID of a workplace
embed =  # array[String] | Names of embeddable resources to be embedded (optional)

try: 
    # Retrieve a workplace.
    api_response = api_instance.get_workplace(workplaceId, embed=embed)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkplaceApi->getWorkplace: %s\n" % e)

Parameters

Path parameters
Name Description
workplaceId*
String
UUID of a workplace
Required
Query parameters
Name Description
embed
array[String]
Names of embeddable resources to be embedded

Responses

Status: 200 - Workplace found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 404 - Unable to find the workplace for the given workplaceId parameter.

Status: 500 - Internal server error


getWorkplaceDevices

Retrieve the devices that belong to a workplace.

These can be embedded systems or individual programmable logic controllers of a machine or several controllers, which are combined to a virtual device. The devices record time series of process parameters and other sensory measured values. The recorded time series are used, among other things, for predictive maintenance. If applicable, sensory measurement time series may also be evaluated in the context of a predictive quality assurance system.


/workplaces/{workplaceId}/devices

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/workplaces/{workplaceId}/devices?limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkplaceApi;

import java.io.File;
import java.util.*;

public class WorkplaceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        WorkplaceApi apiInstance = new WorkplaceApi();
        String workplaceId = workplaceId_example; // String | UUID of a workplace
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        try {
            deviceCollection result = apiInstance.getWorkplaceDevices(workplaceId, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceApi#getWorkplaceDevices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkplaceApi;

public class WorkplaceApiExample {

    public static void main(String[] args) {
        WorkplaceApi apiInstance = new WorkplaceApi();
        String workplaceId = workplaceId_example; // String | UUID of a workplace
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        try {
            deviceCollection result = apiInstance.getWorkplaceDevices(workplaceId, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceApi#getWorkplaceDevices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *workplaceId = workplaceId_example; // UUID of a workplace
Integer *limit = 56; // Size of the requested page (optional) (default to 100)
Integer *offset = 56; // Offset used for pagination (optional) (default to 0)

WorkplaceApi *apiInstance = [[WorkplaceApi alloc] init];

// Retrieve the devices that belong to a workplace.
[apiInstance getWorkplaceDevicesWith:workplaceId
    limit:limit
    offset:offset
              completionHandler: ^(deviceCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.WorkplaceApi()

var workplaceId = workplaceId_example; // {String} UUID of a workplace

var opts = { 
  'limit': 56, // {Integer} Size of the requested page
  'offset': 56 // {Integer} Offset used for pagination
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWorkplaceDevices(workplaceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getWorkplaceDevicesExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WorkplaceApi();
            var workplaceId = workplaceId_example;  // String | UUID of a workplace
            var limit = 56;  // Integer | Size of the requested page (optional)  (default to 100)
            var offset = 56;  // Integer | Offset used for pagination (optional)  (default to 0)

            try
            {
                // Retrieve the devices that belong to a workplace.
                deviceCollection result = apiInstance.getWorkplaceDevices(workplaceId, limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkplaceApi.getWorkplaceDevices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\WorkplaceApi();
$workplaceId = workplaceId_example; // String | UUID of a workplace
$limit = 56; // Integer | Size of the requested page
$offset = 56; // Integer | Offset used for pagination

try {
    $result = $api_instance->getWorkplaceDevices($workplaceId, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkplaceApi->getWorkplaceDevices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkplaceApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WorkplaceApi->new();
my $workplaceId = workplaceId_example; # String | UUID of a workplace
my $limit = 56; # Integer | Size of the requested page
my $offset = 56; # Integer | Offset used for pagination

eval { 
    my $result = $api_instance->getWorkplaceDevices(workplaceId => $workplaceId, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkplaceApi->getWorkplaceDevices: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WorkplaceApi()
workplaceId = workplaceId_example # String | UUID of a workplace
limit = 56 # Integer | Size of the requested page (optional) (default to 100)
offset = 56 # Integer | Offset used for pagination (optional) (default to 0)

try: 
    # Retrieve the devices that belong to a workplace.
    api_response = api_instance.get_workplace_devices(workplaceId, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkplaceApi->getWorkplaceDevices: %s\n" % e)

Parameters

Path parameters
Name Description
workplaceId*
String
UUID of a workplace
Required
Query parameters
Name Description
limit
Integer (int32)
Size of the requested page
offset
Integer (int32)
Offset used for pagination

Responses

Status: 200 - Devices of the workplace were found

Status: 400 - Devices of the workplace were not found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 404 - Unable to find the workplace for the given workplaceId parameter.

Status: 500 - Internal server error

Status: 502 - Received subservice server error.


getWorkplaceOperatingStateSummary

Retrieve the operating state summary of a workplace.

The total duration and frequency of the operating states that have occurred are returned. Furthermore scheduled operating time, occupancy time, processing time, production time and setup time are summed up and the key performance indicators occupancy rate, setup reduction, process availability and availability are calculated. The production time is the sum of the durations of all operating states assigned to the PRODUCTION time base. The setup time is the sum of the durations of all operating states assigned to the SETUP time base. The scheduled operating time is the sum of the durations of all operating states assigned to the SCHEDULED OPERATING TIME time base. Note: The setup time is not necessarily identical to the duration of the setup phase, because operating states that are assigned to the time base SETUP can also occur during the processing phase (e. g. intermediate setup). If such operating states occur during the processing phase, the setup time is longer than the duration of the setup phase and the processing time is shorter than the duration of the processing phase. The scheduled operating time is also not necessarily identical to the duration of the originally scheduled operating time, since operating states that are not assigned to the SCHEDULED OPERATING TIME time base can also occur within the originally scheduled operating time (e.g. spontaneous works council meeting). Such operating states do not reduce the availability of a workplace. For further information, please refer to the documentation at https://docs.forcebridge.io/index.html. A definition of the key figures can be found at https://docs.forcebridge.io/appendix/ .


/workplaces/{workplaceId}/operatingStateSummary

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/workplaces/{workplaceId}/operatingStateSummary?endDate=&limit=&offset=&startDate=&timeBase=&workplaceStateId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkplaceApi;

import java.io.File;
import java.util.*;

public class WorkplaceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        WorkplaceApi apiInstance = new WorkplaceApi();
        String workplaceId = workplaceId_example; // String | UUID of a workplace
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period
        String timeBase = timeBase_example; // String | Time base to be filtered for
        String workplaceStateId = workplaceStateId_example; // String | ID of a workplace state
        try {
            workplaceOperatingStateSummaryCollection result = apiInstance.getWorkplaceOperatingStateSummary(workplaceId, endDate, limit, offset, startDate, timeBase, workplaceStateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceApi#getWorkplaceOperatingStateSummary");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkplaceApi;

public class WorkplaceApiExample {

    public static void main(String[] args) {
        WorkplaceApi apiInstance = new WorkplaceApi();
        String workplaceId = workplaceId_example; // String | UUID of a workplace
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period
        String timeBase = timeBase_example; // String | Time base to be filtered for
        String workplaceStateId = workplaceStateId_example; // String | ID of a workplace state
        try {
            workplaceOperatingStateSummaryCollection result = apiInstance.getWorkplaceOperatingStateSummary(workplaceId, endDate, limit, offset, startDate, timeBase, workplaceStateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceApi#getWorkplaceOperatingStateSummary");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *workplaceId = workplaceId_example; // UUID of a workplace
Date *endDate = 2013-10-20T19:20:30+01:00; // The end date of the considered period (optional) (default to Current timestamp)
Integer *limit = 56; // Size of the requested page (optional) (default to 100)
Integer *offset = 56; // Offset used for pagination (optional) (default to 0)
Date *startDate = 2013-10-20T19:20:30+01:00; // The start date of the considered period (optional) (default to Beginning of the current week)
String *timeBase = timeBase_example; // Time base to be filtered for (optional)
String *workplaceStateId = workplaceStateId_example; // ID of a workplace state (optional)

WorkplaceApi *apiInstance = [[WorkplaceApi alloc] init];

// Retrieve the operating state summary of a workplace.
[apiInstance getWorkplaceOperatingStateSummaryWith:workplaceId
    endDate:endDate
    limit:limit
    offset:offset
    startDate:startDate
    timeBase:timeBase
    workplaceStateId:workplaceStateId
              completionHandler: ^(workplaceOperatingStateSummaryCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.WorkplaceApi()

var workplaceId = workplaceId_example; // {String} UUID of a workplace

var opts = { 
  'endDate': 2013-10-20T19:20:30+01:00, // {Date} The end date of the considered period
  'limit': 56, // {Integer} Size of the requested page
  'offset': 56, // {Integer} Offset used for pagination
  'startDate': 2013-10-20T19:20:30+01:00, // {Date} The start date of the considered period
  'timeBase': timeBase_example, // {String} Time base to be filtered for
  'workplaceStateId': workplaceStateId_example // {String} ID of a workplace state
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWorkplaceOperatingStateSummary(workplaceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getWorkplaceOperatingStateSummaryExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WorkplaceApi();
            var workplaceId = workplaceId_example;  // String | UUID of a workplace
            var endDate = 2013-10-20T19:20:30+01:00;  // Date | The end date of the considered period (optional)  (default to Current timestamp)
            var limit = 56;  // Integer | Size of the requested page (optional)  (default to 100)
            var offset = 56;  // Integer | Offset used for pagination (optional)  (default to 0)
            var startDate = 2013-10-20T19:20:30+01:00;  // Date | The start date of the considered period (optional)  (default to Beginning of the current week)
            var timeBase = timeBase_example;  // String | Time base to be filtered for (optional) 
            var workplaceStateId = workplaceStateId_example;  // String | ID of a workplace state (optional) 

            try
            {
                // Retrieve the operating state summary of a workplace.
                workplaceOperatingStateSummaryCollection result = apiInstance.getWorkplaceOperatingStateSummary(workplaceId, endDate, limit, offset, startDate, timeBase, workplaceStateId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkplaceApi.getWorkplaceOperatingStateSummary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\WorkplaceApi();
$workplaceId = workplaceId_example; // String | UUID of a workplace
$endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period
$limit = 56; // Integer | Size of the requested page
$offset = 56; // Integer | Offset used for pagination
$startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period
$timeBase = timeBase_example; // String | Time base to be filtered for
$workplaceStateId = workplaceStateId_example; // String | ID of a workplace state

try {
    $result = $api_instance->getWorkplaceOperatingStateSummary($workplaceId, $endDate, $limit, $offset, $startDate, $timeBase, $workplaceStateId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkplaceApi->getWorkplaceOperatingStateSummary: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkplaceApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WorkplaceApi->new();
my $workplaceId = workplaceId_example; # String | UUID of a workplace
my $endDate = 2013-10-20T19:20:30+01:00; # Date | The end date of the considered period
my $limit = 56; # Integer | Size of the requested page
my $offset = 56; # Integer | Offset used for pagination
my $startDate = 2013-10-20T19:20:30+01:00; # Date | The start date of the considered period
my $timeBase = timeBase_example; # String | Time base to be filtered for
my $workplaceStateId = workplaceStateId_example; # String | ID of a workplace state

eval { 
    my $result = $api_instance->getWorkplaceOperatingStateSummary(workplaceId => $workplaceId, endDate => $endDate, limit => $limit, offset => $offset, startDate => $startDate, timeBase => $timeBase, workplaceStateId => $workplaceStateId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkplaceApi->getWorkplaceOperatingStateSummary: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WorkplaceApi()
workplaceId = workplaceId_example # String | UUID of a workplace
endDate = 2013-10-20T19:20:30+01:00 # Date | The end date of the considered period (optional) (default to Current timestamp)
limit = 56 # Integer | Size of the requested page (optional) (default to 100)
offset = 56 # Integer | Offset used for pagination (optional) (default to 0)
startDate = 2013-10-20T19:20:30+01:00 # Date | The start date of the considered period (optional) (default to Beginning of the current week)
timeBase = timeBase_example # String | Time base to be filtered for (optional)
workplaceStateId = workplaceStateId_example # String | ID of a workplace state (optional)

try: 
    # Retrieve the operating state summary of a workplace.
    api_response = api_instance.get_workplace_operating_state_summary(workplaceId, endDate=endDate, limit=limit, offset=offset, startDate=startDate, timeBase=timeBase, workplaceStateId=workplaceStateId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkplaceApi->getWorkplaceOperatingStateSummary: %s\n" % e)

Parameters

Path parameters
Name Description
workplaceId*
String
UUID of a workplace
Required
Query parameters
Name Description
endDate
Date (date-time)
The end date of the considered period
limit
Integer (int32)
Size of the requested page
offset
Integer (int32)
Offset used for pagination
startDate
Date (date-time)
The start date of the considered period
timeBase
String
Time base to be filtered for
workplaceStateId
String
ID of a workplace state

Responses

Status: 200 - Operating state summary of the workplace were found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 404 - Unable to find the workplace for the given workplaceId parameter.

Status: 500 - Internal server error


getWorkplaceQuantitySummary

Retrieve the quantity summary of a workplace.

A list of output quantities is returned for each material produced. All output quantities are summarized according to yield, scrap and rework quantity and the production time used for this is returned. In contrast to the specification, which provides the target durations and quantities, the actual durations and quantities are found here. In addition, the performance, the time-based and the quantity-based quality rate are derived from this. A definition of the key figures can be found at https://docs.forcebridge.io/appendix/ .


/workplaces/{workplaceId}/quantitySummary

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/workplaces/{workplaceId}/quantitySummary?endDate=&limit=&materialNumber=&offset=&startDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkplaceApi;

import java.io.File;
import java.util.*;

public class WorkplaceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        WorkplaceApi apiInstance = new WorkplaceApi();
        String workplaceId = workplaceId_example; // String | UUID of a workplace
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period
        Integer limit = 56; // Integer | Size of the requested page
        String materialNumber = materialNumber_example; // String | Material number to be produced at the workplace
        Integer offset = 56; // Integer | Offset used for pagination
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period
        try {
            workplaceQuantitySummary result = apiInstance.getWorkplaceQuantitySummary(workplaceId, endDate, limit, materialNumber, offset, startDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceApi#getWorkplaceQuantitySummary");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkplaceApi;

public class WorkplaceApiExample {

    public static void main(String[] args) {
        WorkplaceApi apiInstance = new WorkplaceApi();
        String workplaceId = workplaceId_example; // String | UUID of a workplace
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period
        Integer limit = 56; // Integer | Size of the requested page
        String materialNumber = materialNumber_example; // String | Material number to be produced at the workplace
        Integer offset = 56; // Integer | Offset used for pagination
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period
        try {
            workplaceQuantitySummary result = apiInstance.getWorkplaceQuantitySummary(workplaceId, endDate, limit, materialNumber, offset, startDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceApi#getWorkplaceQuantitySummary");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *workplaceId = workplaceId_example; // UUID of a workplace
Date *endDate = 2013-10-20T19:20:30+01:00; // The end date of the considered period (optional)
Integer *limit = 56; // Size of the requested page (optional) (default to 100)
String *materialNumber = materialNumber_example; // Material number to be produced at the workplace (optional)
Integer *offset = 56; // Offset used for pagination (optional) (default to 0)
Date *startDate = 2013-10-20T19:20:30+01:00; // The start date of the considered period (optional) (default to Beginning of the current week)

WorkplaceApi *apiInstance = [[WorkplaceApi alloc] init];

// Retrieve the quantity summary of a workplace.
[apiInstance getWorkplaceQuantitySummaryWith:workplaceId
    endDate:endDate
    limit:limit
    materialNumber:materialNumber
    offset:offset
    startDate:startDate
              completionHandler: ^(workplaceQuantitySummary output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.WorkplaceApi()

var workplaceId = workplaceId_example; // {String} UUID of a workplace

var opts = { 
  'endDate': 2013-10-20T19:20:30+01:00, // {Date} The end date of the considered period
  'limit': 56, // {Integer} Size of the requested page
  'materialNumber': materialNumber_example, // {String} Material number to be produced at the workplace
  'offset': 56, // {Integer} Offset used for pagination
  'startDate': 2013-10-20T19:20:30+01:00 // {Date} The start date of the considered period
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWorkplaceQuantitySummary(workplaceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getWorkplaceQuantitySummaryExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WorkplaceApi();
            var workplaceId = workplaceId_example;  // String | UUID of a workplace
            var endDate = 2013-10-20T19:20:30+01:00;  // Date | The end date of the considered period (optional) 
            var limit = 56;  // Integer | Size of the requested page (optional)  (default to 100)
            var materialNumber = materialNumber_example;  // String | Material number to be produced at the workplace (optional) 
            var offset = 56;  // Integer | Offset used for pagination (optional)  (default to 0)
            var startDate = 2013-10-20T19:20:30+01:00;  // Date | The start date of the considered period (optional)  (default to Beginning of the current week)

            try
            {
                // Retrieve the quantity summary of a workplace.
                workplaceQuantitySummary result = apiInstance.getWorkplaceQuantitySummary(workplaceId, endDate, limit, materialNumber, offset, startDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkplaceApi.getWorkplaceQuantitySummary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\WorkplaceApi();
$workplaceId = workplaceId_example; // String | UUID of a workplace
$endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period
$limit = 56; // Integer | Size of the requested page
$materialNumber = materialNumber_example; // String | Material number to be produced at the workplace
$offset = 56; // Integer | Offset used for pagination
$startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period

try {
    $result = $api_instance->getWorkplaceQuantitySummary($workplaceId, $endDate, $limit, $materialNumber, $offset, $startDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkplaceApi->getWorkplaceQuantitySummary: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkplaceApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WorkplaceApi->new();
my $workplaceId = workplaceId_example; # String | UUID of a workplace
my $endDate = 2013-10-20T19:20:30+01:00; # Date | The end date of the considered period
my $limit = 56; # Integer | Size of the requested page
my $materialNumber = materialNumber_example; # String | Material number to be produced at the workplace
my $offset = 56; # Integer | Offset used for pagination
my $startDate = 2013-10-20T19:20:30+01:00; # Date | The start date of the considered period

eval { 
    my $result = $api_instance->getWorkplaceQuantitySummary(workplaceId => $workplaceId, endDate => $endDate, limit => $limit, materialNumber => $materialNumber, offset => $offset, startDate => $startDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkplaceApi->getWorkplaceQuantitySummary: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WorkplaceApi()
workplaceId = workplaceId_example # String | UUID of a workplace
endDate = 2013-10-20T19:20:30+01:00 # Date | The end date of the considered period (optional)
limit = 56 # Integer | Size of the requested page (optional) (default to 100)
materialNumber = materialNumber_example # String | Material number to be produced at the workplace (optional)
offset = 56 # Integer | Offset used for pagination (optional) (default to 0)
startDate = 2013-10-20T19:20:30+01:00 # Date | The start date of the considered period (optional) (default to Beginning of the current week)

try: 
    # Retrieve the quantity summary of a workplace.
    api_response = api_instance.get_workplace_quantity_summary(workplaceId, endDate=endDate, limit=limit, materialNumber=materialNumber, offset=offset, startDate=startDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkplaceApi->getWorkplaceQuantitySummary: %s\n" % e)

Parameters

Path parameters
Name Description
workplaceId*
String
UUID of a workplace
Required
Query parameters
Name Description
endDate
Date (date-time)
The end date of the considered period
limit
Integer (int32)
Size of the requested page
materialNumber
String
Material number to be produced at the workplace
offset
Integer (int32)
Offset used for pagination
startDate
Date (date-time)
The start date of the considered period

Responses

Status: 200 - Quantity summary of a workplace found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 404 - Unable to find the workplace for the given workplaceId parameter.

Status: 500 - Internal server error


getWorkplaceRecordedOperatingStates

Retrieve the recorded operating states of a workplace.

A list of the recorded operating states is returned. Call parameters allow filtering according to a specific time period. Further call parameters also enable filtering according to certain time bases or the workplace state PRODUCTION and DOWNTIME.


/workplaces/{workplaceId}/recordedOperatingStates

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/workplaces/{workplaceId}/recordedOperatingStates?embed=&endDate=&limit=&paginationDirection=&paginationTimestamp=&startDate=&timeBase=&workplaceStateId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkplaceApi;

import java.io.File;
import java.util.*;

public class WorkplaceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        WorkplaceApi apiInstance = new WorkplaceApi();
        String workplaceId = workplaceId_example; // String | UUID of a workplace
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | Operating states with a later start date are excluded. Default value: current time
        Integer limit = 56; // Integer | Size of the requested page
        String paginationDirection = paginationDirection_example; // String | Direction on how to navigate through the response pages
        Date paginationTimestamp = 2013-10-20T19:20:30+01:00; // Date | Timestamp used for pagination
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | Operating states with an earlier start date are excluded
        String timeBase = timeBase_example; // String | Time base to be filtered for
        String workplaceStateId = workplaceStateId_example; // String | ID of a workplace state
        try {
            recordedOperatingStatesCollection result = apiInstance.getWorkplaceRecordedOperatingStates(workplaceId, embed, endDate, limit, paginationDirection, paginationTimestamp, startDate, timeBase, workplaceStateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceApi#getWorkplaceRecordedOperatingStates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkplaceApi;

public class WorkplaceApiExample {

    public static void main(String[] args) {
        WorkplaceApi apiInstance = new WorkplaceApi();
        String workplaceId = workplaceId_example; // String | UUID of a workplace
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | Operating states with a later start date are excluded. Default value: current time
        Integer limit = 56; // Integer | Size of the requested page
        String paginationDirection = paginationDirection_example; // String | Direction on how to navigate through the response pages
        Date paginationTimestamp = 2013-10-20T19:20:30+01:00; // Date | Timestamp used for pagination
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | Operating states with an earlier start date are excluded
        String timeBase = timeBase_example; // String | Time base to be filtered for
        String workplaceStateId = workplaceStateId_example; // String | ID of a workplace state
        try {
            recordedOperatingStatesCollection result = apiInstance.getWorkplaceRecordedOperatingStates(workplaceId, embed, endDate, limit, paginationDirection, paginationTimestamp, startDate, timeBase, workplaceStateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceApi#getWorkplaceRecordedOperatingStates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *workplaceId = workplaceId_example; // UUID of a workplace
array[String] *embed = ; // Names of embeddable resources to be embedded (optional)
Date *endDate = 2013-10-20T19:20:30+01:00; // Operating states with a later start date are excluded. Default value: current time (optional)
Integer *limit = 56; // Size of the requested page (optional) (default to 100)
String *paginationDirection = paginationDirection_example; // Direction on how to navigate through the response pages (optional) (default to NEXT)
Date *paginationTimestamp = 2013-10-20T19:20:30+01:00; // Timestamp used for pagination (optional)
Date *startDate = 2013-10-20T19:20:30+01:00; // Operating states with an earlier start date are excluded (optional)
String *timeBase = timeBase_example; // Time base to be filtered for (optional)
String *workplaceStateId = workplaceStateId_example; // ID of a workplace state (optional)

WorkplaceApi *apiInstance = [[WorkplaceApi alloc] init];

// Retrieve the recorded operating states of a workplace.
[apiInstance getWorkplaceRecordedOperatingStatesWith:workplaceId
    embed:embed
    endDate:endDate
    limit:limit
    paginationDirection:paginationDirection
    paginationTimestamp:paginationTimestamp
    startDate:startDate
    timeBase:timeBase
    workplaceStateId:workplaceStateId
              completionHandler: ^(recordedOperatingStatesCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.WorkplaceApi()

var workplaceId = workplaceId_example; // {String} UUID of a workplace

var opts = { 
  'embed': , // {array[String]} Names of embeddable resources to be embedded
  'endDate': 2013-10-20T19:20:30+01:00, // {Date} Operating states with a later start date are excluded. Default value: current time
  'limit': 56, // {Integer} Size of the requested page
  'paginationDirection': paginationDirection_example, // {String} Direction on how to navigate through the response pages
  'paginationTimestamp': 2013-10-20T19:20:30+01:00, // {Date} Timestamp used for pagination
  'startDate': 2013-10-20T19:20:30+01:00, // {Date} Operating states with an earlier start date are excluded
  'timeBase': timeBase_example, // {String} Time base to be filtered for
  'workplaceStateId': workplaceStateId_example // {String} ID of a workplace state
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWorkplaceRecordedOperatingStates(workplaceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getWorkplaceRecordedOperatingStatesExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WorkplaceApi();
            var workplaceId = workplaceId_example;  // String | UUID of a workplace
            var embed = new array[String](); // array[String] | Names of embeddable resources to be embedded (optional) 
            var endDate = 2013-10-20T19:20:30+01:00;  // Date | Operating states with a later start date are excluded. Default value: current time (optional) 
            var limit = 56;  // Integer | Size of the requested page (optional)  (default to 100)
            var paginationDirection = paginationDirection_example;  // String | Direction on how to navigate through the response pages (optional)  (default to NEXT)
            var paginationTimestamp = 2013-10-20T19:20:30+01:00;  // Date | Timestamp used for pagination (optional) 
            var startDate = 2013-10-20T19:20:30+01:00;  // Date | Operating states with an earlier start date are excluded (optional) 
            var timeBase = timeBase_example;  // String | Time base to be filtered for (optional) 
            var workplaceStateId = workplaceStateId_example;  // String | ID of a workplace state (optional) 

            try
            {
                // Retrieve the recorded operating states of a workplace.
                recordedOperatingStatesCollection result = apiInstance.getWorkplaceRecordedOperatingStates(workplaceId, embed, endDate, limit, paginationDirection, paginationTimestamp, startDate, timeBase, workplaceStateId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkplaceApi.getWorkplaceRecordedOperatingStates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\WorkplaceApi();
$workplaceId = workplaceId_example; // String | UUID of a workplace
$embed = ; // array[String] | Names of embeddable resources to be embedded
$endDate = 2013-10-20T19:20:30+01:00; // Date | Operating states with a later start date are excluded. Default value: current time
$limit = 56; // Integer | Size of the requested page
$paginationDirection = paginationDirection_example; // String | Direction on how to navigate through the response pages
$paginationTimestamp = 2013-10-20T19:20:30+01:00; // Date | Timestamp used for pagination
$startDate = 2013-10-20T19:20:30+01:00; // Date | Operating states with an earlier start date are excluded
$timeBase = timeBase_example; // String | Time base to be filtered for
$workplaceStateId = workplaceStateId_example; // String | ID of a workplace state

try {
    $result = $api_instance->getWorkplaceRecordedOperatingStates($workplaceId, $embed, $endDate, $limit, $paginationDirection, $paginationTimestamp, $startDate, $timeBase, $workplaceStateId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkplaceApi->getWorkplaceRecordedOperatingStates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkplaceApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WorkplaceApi->new();
my $workplaceId = workplaceId_example; # String | UUID of a workplace
my $embed = []; # array[String] | Names of embeddable resources to be embedded
my $endDate = 2013-10-20T19:20:30+01:00; # Date | Operating states with a later start date are excluded. Default value: current time
my $limit = 56; # Integer | Size of the requested page
my $paginationDirection = paginationDirection_example; # String | Direction on how to navigate through the response pages
my $paginationTimestamp = 2013-10-20T19:20:30+01:00; # Date | Timestamp used for pagination
my $startDate = 2013-10-20T19:20:30+01:00; # Date | Operating states with an earlier start date are excluded
my $timeBase = timeBase_example; # String | Time base to be filtered for
my $workplaceStateId = workplaceStateId_example; # String | ID of a workplace state

eval { 
    my $result = $api_instance->getWorkplaceRecordedOperatingStates(workplaceId => $workplaceId, embed => $embed, endDate => $endDate, limit => $limit, paginationDirection => $paginationDirection, paginationTimestamp => $paginationTimestamp, startDate => $startDate, timeBase => $timeBase, workplaceStateId => $workplaceStateId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkplaceApi->getWorkplaceRecordedOperatingStates: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WorkplaceApi()
workplaceId = workplaceId_example # String | UUID of a workplace
embed =  # array[String] | Names of embeddable resources to be embedded (optional)
endDate = 2013-10-20T19:20:30+01:00 # Date | Operating states with a later start date are excluded. Default value: current time (optional)
limit = 56 # Integer | Size of the requested page (optional) (default to 100)
paginationDirection = paginationDirection_example # String | Direction on how to navigate through the response pages (optional) (default to NEXT)
paginationTimestamp = 2013-10-20T19:20:30+01:00 # Date | Timestamp used for pagination (optional)
startDate = 2013-10-20T19:20:30+01:00 # Date | Operating states with an earlier start date are excluded (optional)
timeBase = timeBase_example # String | Time base to be filtered for (optional)
workplaceStateId = workplaceStateId_example # String | ID of a workplace state (optional)

try: 
    # Retrieve the recorded operating states of a workplace.
    api_response = api_instance.get_workplace_recorded_operating_states(workplaceId, embed=embed, endDate=endDate, limit=limit, paginationDirection=paginationDirection, paginationTimestamp=paginationTimestamp, startDate=startDate, timeBase=timeBase, workplaceStateId=workplaceStateId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkplaceApi->getWorkplaceRecordedOperatingStates: %s\n" % e)

Parameters

Path parameters
Name Description
workplaceId*
String
UUID of a workplace
Required
Query parameters
Name Description
embed
array[String]
Names of embeddable resources to be embedded
endDate
Date (date-time)
Operating states with a later start date are excluded. Default value: current time
limit
Integer (int32)
Size of the requested page
paginationDirection
String
Direction on how to navigate through the response pages
paginationTimestamp
Date (date-time)
Timestamp used for pagination
startDate
Date (date-time)
Operating states with an earlier start date are excluded
timeBase
String
Time base to be filtered for
workplaceStateId
String
ID of a workplace state

Responses

Status: 200 - Recorded operating states of a workplace found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 404 - Unable to find the workplace for the given workplaceId parameter.

Status: 500 - Internal server error


getWorkplaceRecordedOutputQuantities

Retrieve the recorded output quantities of a workplace.

A list of the recorded output quantities with the classification in YIELD, SCRAP and REWORK is returned. If operations are currently performed at the workplace, unconfirmed quantities can also occur in the current time period. These are indicated separately as such. Call parameters allow filtering according to a specific time period. Further call parameters also enable filtering according to specific quality types (YIELD, SRCAP or REWORK).


/workplaces/{workplaceId}/recordedOutputQuantities

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/workplaces/{workplaceId}/recordedOutputQuantities?endDate=&limit=&paginationDirection=&paginationIdentifier=&paginationTimestamp=&startDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkplaceApi;

import java.io.File;
import java.util.*;

public class WorkplaceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        WorkplaceApi apiInstance = new WorkplaceApi();
        String workplaceId = workplaceId_example; // String | UUID of a workplace
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period
        Integer limit = 56; // Integer | Size of the requested page
        String paginationDirection = paginationDirection_example; // String | Direction on how to navigate through the response pages
        String paginationIdentifier = paginationIdentifier_example; // String | Identifier used for pagination
        Date paginationTimestamp = 2013-10-20T19:20:30+01:00; // Date | Timestamp used for pagination
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period
        try {
            recordedOutputQuantitiesCollection result = apiInstance.getWorkplaceRecordedOutputQuantities(workplaceId, endDate, limit, paginationDirection, paginationIdentifier, paginationTimestamp, startDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceApi#getWorkplaceRecordedOutputQuantities");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkplaceApi;

public class WorkplaceApiExample {

    public static void main(String[] args) {
        WorkplaceApi apiInstance = new WorkplaceApi();
        String workplaceId = workplaceId_example; // String | UUID of a workplace
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period
        Integer limit = 56; // Integer | Size of the requested page
        String paginationDirection = paginationDirection_example; // String | Direction on how to navigate through the response pages
        String paginationIdentifier = paginationIdentifier_example; // String | Identifier used for pagination
        Date paginationTimestamp = 2013-10-20T19:20:30+01:00; // Date | Timestamp used for pagination
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period
        try {
            recordedOutputQuantitiesCollection result = apiInstance.getWorkplaceRecordedOutputQuantities(workplaceId, endDate, limit, paginationDirection, paginationIdentifier, paginationTimestamp, startDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceApi#getWorkplaceRecordedOutputQuantities");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *workplaceId = workplaceId_example; // UUID of a workplace
Date *endDate = 2013-10-20T19:20:30+01:00; // The end date of the considered period (optional) (default to Current timestamp)
Integer *limit = 56; // Size of the requested page (optional) (default to 100)
String *paginationDirection = paginationDirection_example; // Direction on how to navigate through the response pages (optional) (default to NEXT)
String *paginationIdentifier = paginationIdentifier_example; // Identifier used for pagination (optional)
Date *paginationTimestamp = 2013-10-20T19:20:30+01:00; // Timestamp used for pagination (optional)
Date *startDate = 2013-10-20T19:20:30+01:00; // The start date of the considered period (optional) (default to Beginning of the current week)

WorkplaceApi *apiInstance = [[WorkplaceApi alloc] init];

// Retrieve the recorded output quantities of a workplace.
[apiInstance getWorkplaceRecordedOutputQuantitiesWith:workplaceId
    endDate:endDate
    limit:limit
    paginationDirection:paginationDirection
    paginationIdentifier:paginationIdentifier
    paginationTimestamp:paginationTimestamp
    startDate:startDate
              completionHandler: ^(recordedOutputQuantitiesCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.WorkplaceApi()

var workplaceId = workplaceId_example; // {String} UUID of a workplace

var opts = { 
  'endDate': 2013-10-20T19:20:30+01:00, // {Date} The end date of the considered period
  'limit': 56, // {Integer} Size of the requested page
  'paginationDirection': paginationDirection_example, // {String} Direction on how to navigate through the response pages
  'paginationIdentifier': paginationIdentifier_example, // {String} Identifier used for pagination
  'paginationTimestamp': 2013-10-20T19:20:30+01:00, // {Date} Timestamp used for pagination
  'startDate': 2013-10-20T19:20:30+01:00 // {Date} The start date of the considered period
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWorkplaceRecordedOutputQuantities(workplaceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getWorkplaceRecordedOutputQuantitiesExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WorkplaceApi();
            var workplaceId = workplaceId_example;  // String | UUID of a workplace
            var endDate = 2013-10-20T19:20:30+01:00;  // Date | The end date of the considered period (optional)  (default to Current timestamp)
            var limit = 56;  // Integer | Size of the requested page (optional)  (default to 100)
            var paginationDirection = paginationDirection_example;  // String | Direction on how to navigate through the response pages (optional)  (default to NEXT)
            var paginationIdentifier = paginationIdentifier_example;  // String | Identifier used for pagination (optional) 
            var paginationTimestamp = 2013-10-20T19:20:30+01:00;  // Date | Timestamp used for pagination (optional) 
            var startDate = 2013-10-20T19:20:30+01:00;  // Date | The start date of the considered period (optional)  (default to Beginning of the current week)

            try
            {
                // Retrieve the recorded output quantities of a workplace.
                recordedOutputQuantitiesCollection result = apiInstance.getWorkplaceRecordedOutputQuantities(workplaceId, endDate, limit, paginationDirection, paginationIdentifier, paginationTimestamp, startDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkplaceApi.getWorkplaceRecordedOutputQuantities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\WorkplaceApi();
$workplaceId = workplaceId_example; // String | UUID of a workplace
$endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period
$limit = 56; // Integer | Size of the requested page
$paginationDirection = paginationDirection_example; // String | Direction on how to navigate through the response pages
$paginationIdentifier = paginationIdentifier_example; // String | Identifier used for pagination
$paginationTimestamp = 2013-10-20T19:20:30+01:00; // Date | Timestamp used for pagination
$startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period

try {
    $result = $api_instance->getWorkplaceRecordedOutputQuantities($workplaceId, $endDate, $limit, $paginationDirection, $paginationIdentifier, $paginationTimestamp, $startDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkplaceApi->getWorkplaceRecordedOutputQuantities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkplaceApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WorkplaceApi->new();
my $workplaceId = workplaceId_example; # String | UUID of a workplace
my $endDate = 2013-10-20T19:20:30+01:00; # Date | The end date of the considered period
my $limit = 56; # Integer | Size of the requested page
my $paginationDirection = paginationDirection_example; # String | Direction on how to navigate through the response pages
my $paginationIdentifier = paginationIdentifier_example; # String | Identifier used for pagination
my $paginationTimestamp = 2013-10-20T19:20:30+01:00; # Date | Timestamp used for pagination
my $startDate = 2013-10-20T19:20:30+01:00; # Date | The start date of the considered period

eval { 
    my $result = $api_instance->getWorkplaceRecordedOutputQuantities(workplaceId => $workplaceId, endDate => $endDate, limit => $limit, paginationDirection => $paginationDirection, paginationIdentifier => $paginationIdentifier, paginationTimestamp => $paginationTimestamp, startDate => $startDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkplaceApi->getWorkplaceRecordedOutputQuantities: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WorkplaceApi()
workplaceId = workplaceId_example # String | UUID of a workplace
endDate = 2013-10-20T19:20:30+01:00 # Date | The end date of the considered period (optional) (default to Current timestamp)
limit = 56 # Integer | Size of the requested page (optional) (default to 100)
paginationDirection = paginationDirection_example # String | Direction on how to navigate through the response pages (optional) (default to NEXT)
paginationIdentifier = paginationIdentifier_example # String | Identifier used for pagination (optional)
paginationTimestamp = 2013-10-20T19:20:30+01:00 # Date | Timestamp used for pagination (optional)
startDate = 2013-10-20T19:20:30+01:00 # Date | The start date of the considered period (optional) (default to Beginning of the current week)

try: 
    # Retrieve the recorded output quantities of a workplace.
    api_response = api_instance.get_workplace_recorded_output_quantities(workplaceId, endDate=endDate, limit=limit, paginationDirection=paginationDirection, paginationIdentifier=paginationIdentifier, paginationTimestamp=paginationTimestamp, startDate=startDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkplaceApi->getWorkplaceRecordedOutputQuantities: %s\n" % e)

Parameters

Path parameters
Name Description
workplaceId*
String
UUID of a workplace
Required
Query parameters
Name Description
endDate
Date (date-time)
The end date of the considered period
limit
Integer (int32)
Size of the requested page
paginationDirection
String
Direction on how to navigate through the response pages
paginationIdentifier
String
Identifier used for pagination
paginationTimestamp
Date (date-time)
Timestamp used for pagination
startDate
Date (date-time)
The start date of the considered period

Responses

Status: 200 - Recorded output quantities of the workplace were found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 404 - Unable to find the workplace for the given workplaceId parameter.

Status: 500 - Internal server error


getWorkplaces

Retrieve the collection of workplaces.

A filtered collection of workplaces is returned. Call parameters allow filtering, for example, according to the workplace group number or according to specific workplace number.


/workplaces

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/workplaces?embed=&erpContextId=&isManual=&limit=&offset=&workplaceGroupId=&workplaceGroupNumber=&workplaceNumber="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkplaceApi;

import java.io.File;
import java.util.*;

public class WorkplaceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        WorkplaceApi apiInstance = new WorkplaceApi();
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        String erpContextId = erpContextId_example; // String | Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant
        Boolean isManual = true; // Boolean | Boolean to indicate that a workplace is a manual workplace.
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        String workplaceGroupId = workplaceGroupId_example; // String | UUID of a workplace group
        String workplaceGroupNumber = workplaceGroupNumber_example; // String | Number of a workplace group.
        String workplaceNumber = workplaceNumber_example; // String | The number of the workplace.
        try {
            workplaceCollection result = apiInstance.getWorkplaces(embed, erpContextId, isManual, limit, offset, workplaceGroupId, workplaceGroupNumber, workplaceNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceApi#getWorkplaces");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkplaceApi;

public class WorkplaceApiExample {

    public static void main(String[] args) {
        WorkplaceApi apiInstance = new WorkplaceApi();
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        String erpContextId = erpContextId_example; // String | Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant
        Boolean isManual = true; // Boolean | Boolean to indicate that a workplace is a manual workplace.
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        String workplaceGroupId = workplaceGroupId_example; // String | UUID of a workplace group
        String workplaceGroupNumber = workplaceGroupNumber_example; // String | Number of a workplace group.
        String workplaceNumber = workplaceNumber_example; // String | The number of the workplace.
        try {
            workplaceCollection result = apiInstance.getWorkplaces(embed, erpContextId, isManual, limit, offset, workplaceGroupId, workplaceGroupNumber, workplaceNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceApi#getWorkplaces");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

array[String] *embed = ; // Names of embeddable resources to be embedded (optional)
String *erpContextId = erpContextId_example; // Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant (optional)
Boolean *isManual = true; // Boolean to indicate that a workplace is a manual workplace. (optional)
Integer *limit = 56; // Size of the requested page (optional) (default to 100)
Integer *offset = 56; // Offset used for pagination (optional) (default to 0)
String *workplaceGroupId = workplaceGroupId_example; // UUID of a workplace group (optional)
String *workplaceGroupNumber = workplaceGroupNumber_example; // Number of a workplace group. (optional)
String *workplaceNumber = workplaceNumber_example; // The number of the workplace. (optional)

WorkplaceApi *apiInstance = [[WorkplaceApi alloc] init];

// Retrieve the collection of workplaces.
[apiInstance getWorkplacesWith:embed
    erpContextId:erpContextId
    isManual:isManual
    limit:limit
    offset:offset
    workplaceGroupId:workplaceGroupId
    workplaceGroupNumber:workplaceGroupNumber
    workplaceNumber:workplaceNumber
              completionHandler: ^(workplaceCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.WorkplaceApi()

var opts = { 
  'embed': , // {array[String]} Names of embeddable resources to be embedded
  'erpContextId': erpContextId_example, // {String} Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant
  'isManual': true, // {Boolean} Boolean to indicate that a workplace is a manual workplace.
  'limit': 56, // {Integer} Size of the requested page
  'offset': 56, // {Integer} Offset used for pagination
  'workplaceGroupId': workplaceGroupId_example, // {String} UUID of a workplace group
  'workplaceGroupNumber': workplaceGroupNumber_example, // {String} Number of a workplace group.
  'workplaceNumber': workplaceNumber_example // {String} The number of the workplace.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWorkplaces(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getWorkplacesExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WorkplaceApi();
            var embed = new array[String](); // array[String] | Names of embeddable resources to be embedded (optional) 
            var erpContextId = erpContextId_example;  // String | Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant (optional) 
            var isManual = true;  // Boolean | Boolean to indicate that a workplace is a manual workplace. (optional) 
            var limit = 56;  // Integer | Size of the requested page (optional)  (default to 100)
            var offset = 56;  // Integer | Offset used for pagination (optional)  (default to 0)
            var workplaceGroupId = workplaceGroupId_example;  // String | UUID of a workplace group (optional) 
            var workplaceGroupNumber = workplaceGroupNumber_example;  // String | Number of a workplace group. (optional) 
            var workplaceNumber = workplaceNumber_example;  // String | The number of the workplace. (optional) 

            try
            {
                // Retrieve the collection of workplaces.
                workplaceCollection result = apiInstance.getWorkplaces(embed, erpContextId, isManual, limit, offset, workplaceGroupId, workplaceGroupNumber, workplaceNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkplaceApi.getWorkplaces: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\WorkplaceApi();
$embed = ; // array[String] | Names of embeddable resources to be embedded
$erpContextId = erpContextId_example; // String | Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant
$isManual = true; // Boolean | Boolean to indicate that a workplace is a manual workplace.
$limit = 56; // Integer | Size of the requested page
$offset = 56; // Integer | Offset used for pagination
$workplaceGroupId = workplaceGroupId_example; // String | UUID of a workplace group
$workplaceGroupNumber = workplaceGroupNumber_example; // String | Number of a workplace group.
$workplaceNumber = workplaceNumber_example; // String | The number of the workplace.

try {
    $result = $api_instance->getWorkplaces($embed, $erpContextId, $isManual, $limit, $offset, $workplaceGroupId, $workplaceGroupNumber, $workplaceNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkplaceApi->getWorkplaces: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkplaceApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WorkplaceApi->new();
my $embed = []; # array[String] | Names of embeddable resources to be embedded
my $erpContextId = erpContextId_example; # String | Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant
my $isManual = true; # Boolean | Boolean to indicate that a workplace is a manual workplace.
my $limit = 56; # Integer | Size of the requested page
my $offset = 56; # Integer | Offset used for pagination
my $workplaceGroupId = workplaceGroupId_example; # String | UUID of a workplace group
my $workplaceGroupNumber = workplaceGroupNumber_example; # String | Number of a workplace group.
my $workplaceNumber = workplaceNumber_example; # String | The number of the workplace.

eval { 
    my $result = $api_instance->getWorkplaces(embed => $embed, erpContextId => $erpContextId, isManual => $isManual, limit => $limit, offset => $offset, workplaceGroupId => $workplaceGroupId, workplaceGroupNumber => $workplaceGroupNumber, workplaceNumber => $workplaceNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkplaceApi->getWorkplaces: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WorkplaceApi()
embed =  # array[String] | Names of embeddable resources to be embedded (optional)
erpContextId = erpContextId_example # String | Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant (optional)
isManual = true # Boolean | Boolean to indicate that a workplace is a manual workplace. (optional)
limit = 56 # Integer | Size of the requested page (optional) (default to 100)
offset = 56 # Integer | Offset used for pagination (optional) (default to 0)
workplaceGroupId = workplaceGroupId_example # String | UUID of a workplace group (optional)
workplaceGroupNumber = workplaceGroupNumber_example # String | Number of a workplace group. (optional)
workplaceNumber = workplaceNumber_example # String | The number of the workplace. (optional)

try: 
    # Retrieve the collection of workplaces.
    api_response = api_instance.get_workplaces(embed=embed, erpContextId=erpContextId, isManual=isManual, limit=limit, offset=offset, workplaceGroupId=workplaceGroupId, workplaceGroupNumber=workplaceGroupNumber, workplaceNumber=workplaceNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkplaceApi->getWorkplaces: %s\n" % e)

Parameters

Query parameters
Name Description
embed
array[String]
Names of embeddable resources to be embedded
erpContextId
String
Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant
isManual
Boolean
Boolean to indicate that a workplace is a manual workplace.
limit
Integer (int32)
Size of the requested page
offset
Integer (int32)
Offset used for pagination
workplaceGroupId
String
UUID of a workplace group
workplaceGroupNumber
String
Number of a workplace group.
workplaceNumber
String
The number of the workplace.

Responses

Status: 200 - Workplace collection found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 500 - Internal server error


WorkplaceGroup

getAssignedWorkplaces

Retrieve the assigned workplaces of an individual workplace group.

Retrieve the collection of workplaces assigned to the workplace group.


/workplaceGroups/{workplaceGroupId}/assignedWorkplaces

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/workplaceGroups/{workplaceGroupId}/assignedWorkplaces?limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkplaceGroupApi;

import java.io.File;
import java.util.*;

public class WorkplaceGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        WorkplaceGroupApi apiInstance = new WorkplaceGroupApi();
        String workplaceGroupId = workplaceGroupId_example; // String | UUID of a workplace group
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        try {
            workplaceCollection result = apiInstance.getAssignedWorkplaces(workplaceGroupId, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceGroupApi#getAssignedWorkplaces");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkplaceGroupApi;

public class WorkplaceGroupApiExample {

    public static void main(String[] args) {
        WorkplaceGroupApi apiInstance = new WorkplaceGroupApi();
        String workplaceGroupId = workplaceGroupId_example; // String | UUID of a workplace group
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        try {
            workplaceCollection result = apiInstance.getAssignedWorkplaces(workplaceGroupId, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceGroupApi#getAssignedWorkplaces");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *workplaceGroupId = workplaceGroupId_example; // UUID of a workplace group
Integer *limit = 56; // Size of the requested page (optional) (default to 100)
Integer *offset = 56; // Offset used for pagination (optional) (default to 0)

WorkplaceGroupApi *apiInstance = [[WorkplaceGroupApi alloc] init];

// Retrieve the assigned workplaces of an individual workplace group.
[apiInstance getAssignedWorkplacesWith:workplaceGroupId
    limit:limit
    offset:offset
              completionHandler: ^(workplaceCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.WorkplaceGroupApi()

var workplaceGroupId = workplaceGroupId_example; // {String} UUID of a workplace group

var opts = { 
  'limit': 56, // {Integer} Size of the requested page
  'offset': 56 // {Integer} Offset used for pagination
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAssignedWorkplaces(workplaceGroupId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAssignedWorkplacesExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WorkplaceGroupApi();
            var workplaceGroupId = workplaceGroupId_example;  // String | UUID of a workplace group
            var limit = 56;  // Integer | Size of the requested page (optional)  (default to 100)
            var offset = 56;  // Integer | Offset used for pagination (optional)  (default to 0)

            try
            {
                // Retrieve the assigned workplaces of an individual workplace group.
                workplaceCollection result = apiInstance.getAssignedWorkplaces(workplaceGroupId, limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkplaceGroupApi.getAssignedWorkplaces: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\WorkplaceGroupApi();
$workplaceGroupId = workplaceGroupId_example; // String | UUID of a workplace group
$limit = 56; // Integer | Size of the requested page
$offset = 56; // Integer | Offset used for pagination

try {
    $result = $api_instance->getAssignedWorkplaces($workplaceGroupId, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkplaceGroupApi->getAssignedWorkplaces: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkplaceGroupApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WorkplaceGroupApi->new();
my $workplaceGroupId = workplaceGroupId_example; # String | UUID of a workplace group
my $limit = 56; # Integer | Size of the requested page
my $offset = 56; # Integer | Offset used for pagination

eval { 
    my $result = $api_instance->getAssignedWorkplaces(workplaceGroupId => $workplaceGroupId, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkplaceGroupApi->getAssignedWorkplaces: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WorkplaceGroupApi()
workplaceGroupId = workplaceGroupId_example # String | UUID of a workplace group
limit = 56 # Integer | Size of the requested page (optional) (default to 100)
offset = 56 # Integer | Offset used for pagination (optional) (default to 0)

try: 
    # Retrieve the assigned workplaces of an individual workplace group.
    api_response = api_instance.get_assigned_workplaces(workplaceGroupId, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkplaceGroupApi->getAssignedWorkplaces: %s\n" % e)

Parameters

Path parameters
Name Description
workplaceGroupId*
String
UUID of a workplace group
Required
Query parameters
Name Description
limit
Integer (int32)
Size of the requested page
offset
Integer (int32)
Offset used for pagination

Responses

Status: 200 - Assigned workplaces of workplace group found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 500 - Internal server error


getWorkplaceGroup

Retrieve a workplace group.

Information is returned for domain-specific identification of the workplace group.


/workplaceGroups/{workplaceGroupId}

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/workplaceGroups/{workplaceGroupId}?embed="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkplaceGroupApi;

import java.io.File;
import java.util.*;

public class WorkplaceGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        WorkplaceGroupApi apiInstance = new WorkplaceGroupApi();
        String workplaceGroupId = workplaceGroupId_example; // String | UUID of a workplace group
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        try {
            workplaceGroup result = apiInstance.getWorkplaceGroup(workplaceGroupId, embed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceGroupApi#getWorkplaceGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkplaceGroupApi;

public class WorkplaceGroupApiExample {

    public static void main(String[] args) {
        WorkplaceGroupApi apiInstance = new WorkplaceGroupApi();
        String workplaceGroupId = workplaceGroupId_example; // String | UUID of a workplace group
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        try {
            workplaceGroup result = apiInstance.getWorkplaceGroup(workplaceGroupId, embed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceGroupApi#getWorkplaceGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *workplaceGroupId = workplaceGroupId_example; // UUID of a workplace group
array[String] *embed = ; // Names of embeddable resources to be embedded (optional)

WorkplaceGroupApi *apiInstance = [[WorkplaceGroupApi alloc] init];

// Retrieve a workplace group.
[apiInstance getWorkplaceGroupWith:workplaceGroupId
    embed:embed
              completionHandler: ^(workplaceGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.WorkplaceGroupApi()

var workplaceGroupId = workplaceGroupId_example; // {String} UUID of a workplace group

var opts = { 
  'embed':  // {array[String]} Names of embeddable resources to be embedded
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWorkplaceGroup(workplaceGroupId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getWorkplaceGroupExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WorkplaceGroupApi();
            var workplaceGroupId = workplaceGroupId_example;  // String | UUID of a workplace group
            var embed = new array[String](); // array[String] | Names of embeddable resources to be embedded (optional) 

            try
            {
                // Retrieve a workplace group.
                workplaceGroup result = apiInstance.getWorkplaceGroup(workplaceGroupId, embed);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkplaceGroupApi.getWorkplaceGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\WorkplaceGroupApi();
$workplaceGroupId = workplaceGroupId_example; // String | UUID of a workplace group
$embed = ; // array[String] | Names of embeddable resources to be embedded

try {
    $result = $api_instance->getWorkplaceGroup($workplaceGroupId, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkplaceGroupApi->getWorkplaceGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkplaceGroupApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WorkplaceGroupApi->new();
my $workplaceGroupId = workplaceGroupId_example; # String | UUID of a workplace group
my $embed = []; # array[String] | Names of embeddable resources to be embedded

eval { 
    my $result = $api_instance->getWorkplaceGroup(workplaceGroupId => $workplaceGroupId, embed => $embed);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkplaceGroupApi->getWorkplaceGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WorkplaceGroupApi()
workplaceGroupId = workplaceGroupId_example # String | UUID of a workplace group
embed =  # array[String] | Names of embeddable resources to be embedded (optional)

try: 
    # Retrieve a workplace group.
    api_response = api_instance.get_workplace_group(workplaceGroupId, embed=embed)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkplaceGroupApi->getWorkplaceGroup: %s\n" % e)

Parameters

Path parameters
Name Description
workplaceGroupId*
String
UUID of a workplace group
Required
Query parameters
Name Description
embed
array[String]
Names of embeddable resources to be embedded

Responses

Status: 200 - Workplace group found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 404 - Unable to find the workplace group for the given workplaceGroupId parameter.

Status: 500 - Internal server error


getWorkplaceGroups

Retrieve the collection of workplace groups.

A filtered collection of workplaces is returned. Call parameters allow filtering according to the workplace group number or the type of workplace group, which can be either a capacity group or a production line. A capacity group is the grouping of functionally identical workplaces. Because these often belong to the same cost center, they are usually mapped as a single work center in an ERP system. Production lines are functionally different workplaces whose spatial sequence enables flow production or line production. They, too, are usually mapped in an ERP system as a single work center.


/workplaceGroups

Usage and SDK Samples

curl -X GET "https://localhost:24080/ffwebservices/api/v2/workplaceGroups?embed=&erpContextId=&limit=&offset=&type=&workplaceGroupNumber="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkplaceGroupApi;

import java.io.File;
import java.util.*;

public class WorkplaceGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth2schema
        OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
        oauth2schema.setAccessToken("YOUR ACCESS TOKEN");

        WorkplaceGroupApi apiInstance = new WorkplaceGroupApi();
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        String erpContextId = erpContextId_example; // String | Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        String type = type_example; // String | Type of a workplace group, which is either 'CAPACITY_GROUP' or 'PRODUCTION_LINE'
        String workplaceGroupNumber = workplaceGroupNumber_example; // String | Number of a workplace group
        try {
            workplaceGroupCollection result = apiInstance.getWorkplaceGroups(embed, erpContextId, limit, offset, type, workplaceGroupNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceGroupApi#getWorkplaceGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkplaceGroupApi;

public class WorkplaceGroupApiExample {

    public static void main(String[] args) {
        WorkplaceGroupApi apiInstance = new WorkplaceGroupApi();
        array[String] embed = ; // array[String] | Names of embeddable resources to be embedded
        String erpContextId = erpContextId_example; // String | Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant
        Integer limit = 56; // Integer | Size of the requested page
        Integer offset = 56; // Integer | Offset used for pagination
        String type = type_example; // String | Type of a workplace group, which is either 'CAPACITY_GROUP' or 'PRODUCTION_LINE'
        String workplaceGroupNumber = workplaceGroupNumber_example; // String | Number of a workplace group
        try {
            workplaceGroupCollection result = apiInstance.getWorkplaceGroups(embed, erpContextId, limit, offset, type, workplaceGroupNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkplaceGroupApi#getWorkplaceGroups");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

array[String] *embed = ; // Names of embeddable resources to be embedded (optional)
String *erpContextId = erpContextId_example; // Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant (optional)
Integer *limit = 56; // Size of the requested page (optional) (default to 100)
Integer *offset = 56; // Offset used for pagination (optional) (default to 0)
String *type = type_example; // Type of a workplace group, which is either 'CAPACITY_GROUP' or 'PRODUCTION_LINE' (optional)
String *workplaceGroupNumber = workplaceGroupNumber_example; // Number of a workplace group (optional)

WorkplaceGroupApi *apiInstance = [[WorkplaceGroupApi alloc] init];

// Retrieve the collection of workplace groups.
[apiInstance getWorkplaceGroupsWith:embed
    erpContextId:erpContextId
    limit:limit
    offset:offset
    type:type
    workplaceGroupNumber:workplaceGroupNumber
              completionHandler: ^(workplaceGroupCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BridgeMdcApi.WorkplaceGroupApi()

var opts = { 
  'embed': , // {array[String]} Names of embeddable resources to be embedded
  'erpContextId': erpContextId_example, // {String} Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant
  'limit': 56, // {Integer} Size of the requested page
  'offset': 56, // {Integer} Offset used for pagination
  'type': type_example, // {String} Type of a workplace group, which is either 'CAPACITY_GROUP' or 'PRODUCTION_LINE'
  'workplaceGroupNumber': workplaceGroupNumber_example // {String} Number of a workplace group
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWorkplaceGroups(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getWorkplaceGroupsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2schema
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WorkplaceGroupApi();
            var embed = new array[String](); // array[String] | Names of embeddable resources to be embedded (optional) 
            var erpContextId = erpContextId_example;  // String | Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant (optional) 
            var limit = 56;  // Integer | Size of the requested page (optional)  (default to 100)
            var offset = 56;  // Integer | Offset used for pagination (optional)  (default to 0)
            var type = type_example;  // String | Type of a workplace group, which is either 'CAPACITY_GROUP' or 'PRODUCTION_LINE' (optional) 
            var workplaceGroupNumber = workplaceGroupNumber_example;  // String | Number of a workplace group (optional) 

            try
            {
                // Retrieve the collection of workplace groups.
                workplaceGroupCollection result = apiInstance.getWorkplaceGroups(embed, erpContextId, limit, offset, type, workplaceGroupNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkplaceGroupApi.getWorkplaceGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\WorkplaceGroupApi();
$embed = ; // array[String] | Names of embeddable resources to be embedded
$erpContextId = erpContextId_example; // String | Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant
$limit = 56; // Integer | Size of the requested page
$offset = 56; // Integer | Offset used for pagination
$type = type_example; // String | Type of a workplace group, which is either 'CAPACITY_GROUP' or 'PRODUCTION_LINE'
$workplaceGroupNumber = workplaceGroupNumber_example; // String | Number of a workplace group

try {
    $result = $api_instance->getWorkplaceGroups($embed, $erpContextId, $limit, $offset, $type, $workplaceGroupNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkplaceGroupApi->getWorkplaceGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WorkplaceGroupApi;

# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WorkplaceGroupApi->new();
my $embed = []; # array[String] | Names of embeddable resources to be embedded
my $erpContextId = erpContextId_example; # String | Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant
my $limit = 56; # Integer | Size of the requested page
my $offset = 56; # Integer | Offset used for pagination
my $type = type_example; # String | Type of a workplace group, which is either 'CAPACITY_GROUP' or 'PRODUCTION_LINE'
my $workplaceGroupNumber = workplaceGroupNumber_example; # String | Number of a workplace group

eval { 
    my $result = $api_instance->getWorkplaceGroups(embed => $embed, erpContextId => $erpContextId, limit => $limit, offset => $offset, type => $type, workplaceGroupNumber => $workplaceGroupNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkplaceGroupApi->getWorkplaceGroups: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WorkplaceGroupApi()
embed =  # array[String] | Names of embeddable resources to be embedded (optional)
erpContextId = erpContextId_example # String | Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant (optional)
limit = 56 # Integer | Size of the requested page (optional) (default to 100)
offset = 56 # Integer | Offset used for pagination (optional) (default to 0)
type = type_example # String | Type of a workplace group, which is either 'CAPACITY_GROUP' or 'PRODUCTION_LINE' (optional)
workplaceGroupNumber = workplaceGroupNumber_example # String | Number of a workplace group (optional)

try: 
    # Retrieve the collection of workplace groups.
    api_response = api_instance.get_workplace_groups(embed=embed, erpContextId=erpContextId, limit=limit, offset=offset, type=type, workplaceGroupNumber=workplaceGroupNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkplaceGroupApi->getWorkplaceGroups: %s\n" % e)

Parameters

Query parameters
Name Description
embed
array[String]
Names of embeddable resources to be embedded
erpContextId
String
Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant
limit
Integer (int32)
Size of the requested page
offset
Integer (int32)
Offset used for pagination
type
String
Type of a workplace group, which is either 'CAPACITY_GROUP' or 'PRODUCTION_LINE'
workplaceGroupNumber
String
Number of a workplace group

Responses

Status: 200 - Collection of workplace groups found

Status: 401 - No or an invalid request token was returned

Status: 403 - Request requires higher privileges than provided by the access token

Status: 500 - Internal server error